From d15a7f21c561f63573cddf5c77a785f354df73d4 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Wed, 15 Nov 2023 17:19:04 +0100 Subject: [PATCH 01/19] stop managing cv filter rules from content_view_filter module (#1680) * stop managing cv filter rules from content_view_filter module * content_views role fixes --- ...ntent_view_filter-drop-rule-management.yml | 2 + plugins/modules/content_view_filter.py | 184 +------ .../tasks/_create_content_view.yml | 19 +- tests/test_playbooks/content_view_filter.yml | 35 -- .../fixtures/content_view_filter-0.yml | 151 ++---- .../fixtures/content_view_filter-1.yml | 234 +++----- .../fixtures/content_view_filter-10.yml | 337 ++---------- .../fixtures/content_view_filter-11.yml | 231 ++------ .../fixtures/content_view_filter-12.yml | 302 ++--------- .../fixtures/content_view_filter-13.yml | 134 ++--- .../fixtures/content_view_filter-14.yml | 116 +--- .../fixtures/content_view_filter-15.yml | 175 ++---- .../fixtures/content_view_filter-16.yml | 80 +-- .../fixtures/content_view_filter-17.yml | 250 +-------- .../fixtures/content_view_filter-18.yml | 314 ++--------- .../fixtures/content_view_filter-19.yml | 337 ++---------- .../fixtures/content_view_filter-2.yml | 269 +++------- .../fixtures/content_view_filter-20.yml | 383 ++----------- .../fixtures/content_view_filter-21.yml | 266 ++------- .../fixtures/content_view_filter-22.yml | 207 ++----- .../fixtures/content_view_filter-23.yml | 223 +++----- .../fixtures/content_view_filter-24.yml | 169 ++++-- .../fixtures/content_view_filter-25.yml | 243 +++++++-- .../fixtures/content_view_filter-26.yml | 177 ++++-- .../fixtures/content_view_filter-27.yml | 366 ------------- .../fixtures/content_view_filter-28.yml | 300 ----------- .../fixtures/content_view_filter-3.yml | 234 +++----- .../fixtures/content_view_filter-30.yml | 366 ------------- .../fixtures/content_view_filter-31.yml | 428 --------------- .../fixtures/content_view_filter-32.yml | 435 --------------- .../fixtures/content_view_filter-33.yml | 507 ------------------ .../fixtures/content_view_filter-34.yml | 499 ----------------- .../fixtures/content_view_filter-4.yml | 269 +++------- .../fixtures/content_view_filter-5.yml | 234 +++----- .../fixtures/content_view_filter-6.yml | 264 +++------ .../fixtures/content_view_filter-7.yml | 195 +++---- .../fixtures/content_view_filter-8.yml | 382 ++----------- .../fixtures/content_view_filter-9.yml | 314 ++--------- .../fixtures/content_views_role-0.yml | 111 ++-- .../fixtures/content_views_role-1.yml | 125 ++--- .../fixtures/content_views_role-2.yml | 111 ++-- .../fixtures/content_views_role-3.yml | 150 ++---- ...filter-29.yml => content_views_role-4.yml} | 126 +++-- .../tasks/content_view_filter_deb.yml | 4 - .../tasks/content_view_filter_docker.yml | 3 - .../tasks/content_view_filter_errata_date.yml | 7 - .../tasks/content_view_filter_errata_id.yml | 3 - .../tasks/content_view_filter_package.yml | 7 - .../content_view_filter_package_group.yml | 3 - 49 files changed, 1992 insertions(+), 8289 deletions(-) create mode 100644 changelogs/fragments/content_view_filter-drop-rule-management.yml delete mode 100644 tests/test_playbooks/fixtures/content_view_filter-27.yml delete mode 100644 tests/test_playbooks/fixtures/content_view_filter-28.yml delete mode 100644 tests/test_playbooks/fixtures/content_view_filter-30.yml delete mode 100644 tests/test_playbooks/fixtures/content_view_filter-31.yml delete mode 100644 tests/test_playbooks/fixtures/content_view_filter-32.yml delete mode 100644 tests/test_playbooks/fixtures/content_view_filter-33.yml delete mode 100644 tests/test_playbooks/fixtures/content_view_filter-34.yml rename tests/test_playbooks/fixtures/{content_view_filter-29.yml => content_views_role-4.yml} (64%) diff --git a/changelogs/fragments/content_view_filter-drop-rule-management.yml b/changelogs/fragments/content_view_filter-drop-rule-management.yml new file mode 100644 index 000000000..4df72636e --- /dev/null +++ b/changelogs/fragments/content_view_filter-drop-rule-management.yml @@ -0,0 +1,2 @@ +breaking_changes: + - content_view_filter - stop managing rules from this module, ``content_view_filter_rule`` should be used for that diff --git a/plugins/modules/content_view_filter.py b/plugins/modules/content_view_filter.py index ae2d04f94..894784f83 100644 --- a/plugins/modules/content_view_filter.py +++ b/plugins/modules/content_view_filter.py @@ -28,10 +28,6 @@ - Create and manage content View filters author: "Sean O'Keeffe (@sean797)" options: - architecture: - description: - - package architecture - type: str name: description: - Name of the Content View Filter @@ -46,7 +42,7 @@ - Name of the content view required: true type: str - filter_state: + state: description: - State of the content view filter default: present @@ -54,6 +50,8 @@ - present - absent type: str + aliases: + - filter_state repositories: description: - List of repositories that include name and product @@ -61,14 +59,6 @@ default: [] type: list elements: dict - rule_state: - description: - - State of the content view filter rule - default: present - choices: - - present - - absent - type: str filter_type: description: - Content view filter type @@ -81,54 +71,6 @@ - modulemd - deb type: str - rule_name: - description: - - Content view filter rule name or package name - - If omitted, the value of I(name) will be used if necessary - aliases: - - package_name - - package_group - - tag - type: str - date_type: - description: - - Search using the 'Issued On' or 'Updated On' - - Only valid on I(filter_type=erratum). - default: updated - choices: - - issued - - updated - type: str - end_date: - description: - - erratum end date (YYYY-MM-DD) - type: str - start_date: - description: - - erratum start date (YYYY-MM-DD) - type: str - errata_id: - description: - - erratum id - type: str - max_version: - description: - - package maximum version - type: str - min_version: - description: - - package minimum version - type: str - types: - description: - - erratum types (enhancement, bugfix, security) - default: ["bugfix", "enhancement", "security"] - type: list - elements: str - version: - description: - - package version - type: str inclusion: description: - Create an include filter @@ -187,57 +129,10 @@ elements: dict ''' -from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloMixin, ForemanStatelessEntityAnsibleModule - -content_filter_spec = { - 'id': {}, - 'name': {}, - 'description': {}, - 'repositories': {'type': 'entity_list'}, - 'inclusion': {}, - 'content_view': {'type': 'entity'}, - 'filter_type': {'flat_name': 'type'}, - 'original_packages': {}, - 'original_module_streams': {}, -} - -content_filter_rule_erratum_spec = { - 'id': {}, - 'date_type': {}, - 'end_date': {}, - 'start_date': {}, - 'types': {'type': 'list'}, -} - -content_filter_rule_erratum_id_spec = { - 'id': {}, - 'errata_id': {}, - 'date_type': {}, -} +from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloMixin, ForemanEntityAnsibleModule -content_filter_rule_rpm_spec = { - 'id': {}, - 'rule_name': {'flat_name': 'name'}, - 'end_date': {}, - 'max_version': {}, - 'min_version': {}, - 'version': {}, - 'architecture': {}, -} -content_filter_rule_package_group_spec = { - 'id': {}, - 'rule_name': {'flat_name': 'name'}, - 'uuid': {}, -} - -content_filter_rule_docker_spec = { - 'id': {}, - 'rule_name': {'flat_name': 'name'}, -} - - -class KatelloContentViewFilterModule(KatelloMixin, ForemanStatelessEntityAnsibleModule): +class KatelloContentViewFilterModule(KatelloMixin, ForemanEntityAnsibleModule): pass @@ -246,36 +141,19 @@ def main(): foreman_spec=dict( name=dict(required=True), description=dict(), - repositories=dict(type='list', default=[], elements='dict'), + repositories=dict(type='entity_list', default=[], elements='dict'), inclusion=dict(type='bool', default=False), original_packages=dict(type='bool'), content_view=dict(type='entity', scope=['organization'], required=True), - filter_type=dict(required=True, choices=['rpm', 'package_group', 'erratum', 'docker', 'modulemd', 'deb']), - filter_state=dict(default='present', choices=['present', 'absent']), - rule_state=dict(default='present', choices=['present', 'absent']), - rule_name=dict(aliases=['package_name', 'package_group', 'tag']), - date_type=dict(default='updated', choices=['issued', 'updated']), - end_date=dict(), - errata_id=dict(), - max_version=dict(), - min_version=dict(), - start_date=dict(), - types=dict(default=["bugfix", "enhancement", "security"], type='list', elements='str'), - version=dict(), - architecture=dict(), + filter_type=dict(required=True, choices=['rpm', 'package_group', 'erratum', 'docker', 'modulemd', 'deb'], flat_name='type'), original_module_streams=dict(type='bool'), ), + argument_spec=dict( + state=dict(default='present', choices=['present', 'absent'], aliases=['filter_state']), + ), entity_opts=dict(scope=['content_view']), ) - filter_state = module.foreman_params.pop('filter_state') - rule_state = module.foreman_params.pop('rule_state') - - if module.foreman_params['filter_type'] == 'erratum': - module.foreman_params['rule_name'] = None - elif 'rule_name' not in module.foreman_params: - module.foreman_params['rule_name'] = module.foreman_params['name'] - with module.api_connection(): scope = module.scope_for('organization') @@ -288,52 +166,16 @@ def main(): repositories.append(module.find_resource_by_name('repositories', repo['name'], params=product_scope, thin=True)) module.foreman_params['repositories'] = repositories + if not module.desired_absent: + module.foreman_params.pop('organization') entity = module.lookup_entity('entity') - content_view_filter = module.ensure_entity( + module.ensure_entity( 'content_view_filters', module.foreman_params, entity, params=cv_scope, - state=filter_state, - foreman_spec=content_filter_spec, ) - if content_view_filter is not None and module.foreman_params['filter_type'] not in ['modulemd', 'deb']: - cv_filter_scope = {'content_view_filter_id': content_view_filter['id']} - if 'errata_id' in module.foreman_params: - # should we try to find the errata the user is asking for? or just pass it blindly? - # errata = module.find_resource('errata', 'id={0}'.format(module.foreman_params['errata_id']), params=scope) - rule_spec = content_filter_rule_erratum_id_spec - search_scope = {'errata_id': module.foreman_params['errata_id']} - search_scope.update(cv_filter_scope) - search = None - else: - rule_spec = globals()['content_filter_rule_%s_spec' % (module.foreman_params['filter_type'])] - search_scope = cv_filter_scope - if module.foreman_params['rule_name'] is not None: - search = 'name="{0}"'.format(module.foreman_params['rule_name']) - else: - search = None - # not using find_resource_by_name here, because not all filters (errata) have names - content_view_filter_rule = module.find_resource('content_view_filter_rules', search, params=search_scope, failsafe=True) if entity else None - - if module.foreman_params['filter_type'] == 'package_group': - package_group = module.find_resource_by_name('package_groups', module.foreman_params['rule_name'], params=scope) - module.foreman_params['uuid'] = package_group['uuid'] - - # drop 'name' from the dict, as otherwise it might override 'rule_name' - rule_dict = module.foreman_params.copy() - rule_dict.pop('name', None) - - module.ensure_entity( - 'content_view_filter_rules', - rule_dict, - content_view_filter_rule, - params=cv_filter_scope, - state=rule_state, - foreman_spec=rule_spec, - ) - if __name__ == '__main__': main() diff --git a/roles/content_views/tasks/_create_content_view.yml b/roles/content_views/tasks/_create_content_view.yml index 04257584f..1d56f3878 100644 --- a/roles/content_views/tasks/_create_content_view.yml +++ b/roles/content_views/tasks/_create_content_view.yml @@ -26,19 +26,32 @@ content_view: "{{ content_view.name }}" repositories: "{{ item.repositories | default(omit) }}" filter_type: "{{ item.filter_type }}" + inclusion: "{{ item.inclusion | default(omit) }}" + description: "{{ item.description | default(omit) }}" + filter_state: "{{ item.filter_state | default(omit) }}" + original_packages: "{{ item.original_packages | default(omit) }}" + original_module_streams: "{{ item.original_module_streams | default(omit) }}" + loop: "{{ content_view.filters | default([]) }}" + +- name: Add content view filters rules + theforeman.foreman.content_view_filter_rule: + username: "{{ foreman_username | default(omit) }}" + password: "{{ foreman_password | default(omit) }}" + server_url: "{{ foreman_server_url | default(omit) }}" + validate_certs: "{{ foreman_validate_certs | default(omit) }}" + organization: "{{ foreman_organization }}" + content_view_filter: "{{ item.name }}" + content_view: "{{ content_view.name }}" start_date: "{{ item.start_date | default(omit) }}" end_date: "{{ item.end_date | default(omit) }}" types: "{{ item.types | default(omit) }}" date_type: "{{ item.date_type | default(omit) }}" - inclusion: "{{ item.inclusion | default(omit) }}" errata_id: "{{ item.errata_id | default(omit) }}" max_version: "{{ item.max_version | default(omit) }}" min_version: "{{ item.min_version | default(omit) }}" rule_name: "{{ item.rule_name | default(omit) }}" version: "{{ item.version | default(omit) }}" - description: "{{ item.description | default(omit) }}" architecture: "{{ item.architecture | default(omit) }}" - filter_state: "{{ item.filter_state | default(omit) }}" original_packages: "{{ item.original_packages | default(omit) }}" original_module_streams: "{{ item.original_module_streams | default(omit) }}" rule_state: "{{ item.rule_state | default(omit) }}" diff --git a/tests/test_playbooks/content_view_filter.yml b/tests/test_playbooks/content_view_filter.yml index edfff36d8..5a5578b9e 100644 --- a/tests/test_playbooks/content_view_filter.yml +++ b/tests/test_playbooks/content_view_filter.yml @@ -106,33 +106,6 @@ original_packages: false expected_change: false - - include_tasks: tasks/content_view_filter_package.yml - vars: - version: 1 - expected_change: true - - include_tasks: tasks/content_view_filter_package.yml - vars: - version: 1 - expected_change: false - - - include_tasks: tasks/content_view_filter_package.yml - vars: - max_version: 1 - expected_change: true - - include_tasks: tasks/content_view_filter_package.yml - vars: - max_version: 1 - expected_change: false - - - include_tasks: tasks/content_view_filter_package.yml - vars: - min_version: 1 - expected_change: true - - include_tasks: tasks/content_view_filter_package.yml - vars: - min_version: 1 - expected_change: false - - include_tasks: tasks/content_view_filter_package.yml vars: inclusion: true @@ -165,14 +138,6 @@ - include_tasks: tasks/content_view_filter_errata_date.yml vars: expected_change: false - - include_tasks: tasks/content_view_filter_errata_date.yml - vars: - date_type: issued - expected_change: true - - include_tasks: tasks/content_view_filter_errata_date.yml - vars: - types: security - expected_change: true - include_tasks: tasks/content_view_filter_errata_date.yml vars: filter_state: absent diff --git a/tests/test_playbooks/fixtures/content_view_filter-0.yml b/tests/test_playbooks/fixtures/content_view_filter-0.yml index ad1afa403..a203e4fde 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-0.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-0.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1049' + - '1050' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -188,9 +188,9 @@ interactions: response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"less than + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' @@ -200,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '690' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -214,7 +214,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -244,17 +244,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"org_repository_count":3} ' headers: @@ -263,7 +263,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1838' + - '1879' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -277,7 +277,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -307,7 +307,7 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test @@ -334,7 +334,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -354,7 +354,7 @@ interactions: message: OK - request: body: '{"name": "Test Package Content View Filter", "type": "rpm", "inclusion": - false, "repository_ids": [11]}' + false, "repository_ids": [18]}' headers: Accept: - application/json;version=2 @@ -369,23 +369,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/content_views/8/filters + uri: https://foreman.example.org/katello/api/content_views/10/filters response: body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:17 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"original_packages":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:10 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]} ' headers: @@ -394,7 +396,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '2937' + - '3156' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -408,7 +410,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -426,65 +428,4 @@ interactions: status: code: 201 message: Created -- request: - body: '{"name": "bear"}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '16' - Content-Type: - - application/json - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: POST - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules - response: - body: - string: ' {"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '131' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 201 - message: Created version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-1.yml b/tests/test_playbooks/fixtures/content_view_filter-1.yml index 2673db846..defe6f2fa 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-1.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-1.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -188,9 +188,9 @@ interactions: response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"less than + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' @@ -200,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '690' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -214,7 +214,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -244,17 +244,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"org_repository_count":3} ' headers: @@ -263,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1838' + - '2056' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -277,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -307,24 +309,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:17 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:10 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]}]} ' headers: @@ -333,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3058' + - '3148' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,7 +350,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -377,24 +380,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/8 response: body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:17 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"original_packages":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:10 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]} ' headers: @@ -403,7 +407,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3065' + - '3156' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,7 +421,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -435,118 +439,4 @@ interactions: status: code: 200 message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '285' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 - response: - body: - string: ' {"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '131' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-10.yml b/tests/test_playbooks/fixtures/content_view_filter-10.yml index 1c2c129ed..ad2dba0d9 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-10.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-10.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,147 +184,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Errata+id+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Errata id Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":9,"name":"Test + Errata id Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:16 UTC","updated_at":"2023-11-15 09:55:16 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"max_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:28 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[]}]} ' headers: @@ -333,7 +203,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3076' + - '1295' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,9 +217,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=95 + - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -377,24 +247,16 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/9 response: body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":9,"name":"Test Errata id Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:16 UTC","updated_at":"2023-11-15 09:55:16 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"max_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:28 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[]} ' headers: @@ -403,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3083' + - '1275' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,66 +279,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"max_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:28 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '303' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 + - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -501,75 +306,21 @@ interactions: - gzip, deflate Connection: - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 - response: - body: - string: ' {"content_view_filter_id":16,"max_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:28 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive Content-Length: - - '149' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: '{"min_version": "1"}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '20' - Content-Type: - - application/json + - '0' User-Agent: - apypie (https://github.com/Apipie/apypie) - method: PUT - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 + method: DELETE + uri: https://foreman.example.org/katello/api/content_views/10/filters/9 response: body: - string: ' {"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"} + string: ' {"inclusion":false,"id":9,"name":"Test Errata id Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:16 UTC","updated_at":"2023-11-15 09:55:16 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[]} ' headers: @@ -578,7 +329,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '149' + - '1276' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -592,9 +343,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=91 + - timeout=15, max=95 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: diff --git a/tests/test_playbooks/fixtures/content_view_filter-11.yml b/tests/test_playbooks/fixtures/content_view_filter-11.yml index 031d49bc5..74cb129f9 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-11.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-11.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1050' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -188,10 +188,10 @@ interactions: response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than + a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' headers: @@ -200,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '680' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -214,7 +214,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -244,15 +244,15 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 minute"}],"org_repository_count":3} @@ -263,7 +263,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1838' + - '1869' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -277,7 +277,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -307,24 +307,11 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Errata+date+Content+View+Filter%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"}]}]} + string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Errata date Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} ' headers: @@ -333,7 +320,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3076' + - '191' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,7 +334,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -366,7 +353,8 @@ interactions: code: 200 message: OK - request: - body: null + body: '{"name": "Test Errata date Content View Filter", "type": "erratum", "inclusion": + false, "repository_ids": [18]}' headers: Accept: - application/json;version=2 @@ -374,27 +362,32 @@ interactions: - gzip, deflate Connection: - keep-alive + Content-Length: + - '111' + Content-Type: + - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + method: POST + uri: https://foreman.example.org/katello/api/content_views/10/filters response: body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":10,"name":"Test Errata date Content View + Filter","description":null,"created_at":"2023-11-15 09:55:19 UTC","updated_at":"2023-11-15 + 09:55:19 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":10,"content_view_filter_name":"Test + Errata date Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"}]} + minute"}],"type":"erratum","rules":[]} ' headers: @@ -403,7 +396,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3083' + - '3134' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,7 +410,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -433,120 +426,6 @@ interactions: X-XSS-Protection: - 1; mode=block status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '303' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 - response: - body: - string: ' {"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '149' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK + code: 201 + message: Created version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-12.yml b/tests/test_playbooks/fixtures/content_view_filter-12.yml index 7ed008ccc..2a233a226 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-12.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-12.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -188,10 +188,10 @@ interactions: response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than + a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' headers: @@ -200,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '680' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -214,7 +214,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -244,15 +244,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":10,"content_view_filter_name":"Test + Errata date Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 minute"}],"org_repository_count":3} @@ -263,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1838' + - '2051' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -277,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -307,24 +309,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Errata+date+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Errata date Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":10,"name":"Test + Errata date Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:19 UTC","updated_at":"2023-11-15 09:55:19 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":10,"content_view_filter_name":"Test + Errata date Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"}]}]} + minute"}],"type":"erratum","rules":[]}]} ' headers: @@ -333,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3076' + - '3156' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,7 +350,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -377,24 +380,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/10 response: body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":10,"name":"Test Errata date Content View + Filter","description":null,"created_at":"2023-11-15 09:55:19 UTC","updated_at":"2023-11-15 + 09:55:19 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":10,"content_view_filter_name":"Test + Errata date Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"}]} + minute"}],"type":"erratum","rules":[]} ' headers: @@ -403,7 +407,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3083' + - '3134' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,7 +421,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -435,192 +439,4 @@ interactions: status: code: 200 message: OK -- request: - body: '{"inclusion": true}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '19' - Content-Type: - - application/json - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: PUT - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 - response: - body: - string: ' {"inclusion":true,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:33 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '3082' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '303' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 - response: - body: - string: ' {"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '149' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=91 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-13.yml b/tests/test_playbooks/fixtures/content_view_filter-13.yml index df6df921f..1e0727b4c 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-13.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-13.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -188,10 +188,10 @@ interactions: response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than + a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' headers: @@ -200,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '680' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -214,7 +214,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -244,15 +244,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":10,"content_view_filter_name":"Test + Errata date Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 minute"}],"org_repository_count":3} @@ -263,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1838' + - '2051' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -277,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -307,24 +309,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Errata+date+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":true,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:33 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Errata date Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":10,"name":"Test + Errata date Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:19 UTC","updated_at":"2023-11-15 09:55:19 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":10,"content_view_filter_name":"Test + Errata date Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"}]}]} + minute"}],"type":"erratum","rules":[]}]} ' headers: @@ -333,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3075' + - '3156' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,7 +350,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -377,24 +380,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/10 response: body: - string: ' {"inclusion":true,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:33 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":10,"name":"Test Errata date Content View + Filter","description":null,"created_at":"2023-11-15 09:55:19 UTC","updated_at":"2023-11-15 + 09:55:19 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":10,"content_view_filter_name":"Test + Errata date Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"min_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:31 UTC"}]} + minute"}],"type":"erratum","rules":[]} ' headers: @@ -403,7 +407,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3082' + - '3134' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,7 +421,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -449,17 +453,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: DELETE - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/10 response: body: - string: ' {"inclusion":true,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:33 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":10,"name":"Test Errata date Content View + Filter","description":null,"created_at":"2023-11-15 09:55:19 UTC","updated_at":"2023-11-15 + 09:55:19 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"rpm","rules":[]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[]} ' headers: @@ -468,7 +472,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1294' + - '1279' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -482,7 +486,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=93 Strict-Transport-Security: diff --git a/tests/test_playbooks/fixtures/content_view_filter-14.yml b/tests/test_playbooks/fixtures/content_view_filter-14.yml index 8da256417..021428a65 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-14.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-14.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1049' + - '1050' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,11 +184,11 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Errata+id+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Package+Group+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Errata id Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} + Package Group Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} ' headers: @@ -197,7 +197,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '189' + - '193' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -211,7 +211,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -230,8 +230,8 @@ interactions: code: 200 message: OK - request: - body: '{"name": "Test Errata id Content View Filter", "type": "erratum", "inclusion": - false, "repository_ids": []}' + body: '{"name": "Test Package Group Content View Filter", "type": "package_group", + "inclusion": false, "repository_ids": []}' headers: Accept: - application/json;version=2 @@ -240,22 +240,23 @@ interactions: Connection: - keep-alive Content-Length: - - '107' + - '117' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/content_views/8/filters + uri: https://foreman.example.org/katello/api/content_views/10/filters response: body: - string: ' {"inclusion":false,"id":17,"name":"Test Errata id Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":11,"name":"Test Package Group Content View + Filter","description":null,"created_at":"2023-11-15 09:55:21 UTC","updated_at":"2023-11-15 + 09:55:21 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[]} ' headers: @@ -264,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1274' + - '1286' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -278,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -296,65 +297,4 @@ interactions: status: code: 201 message: Created -- request: - body: '{"errata_id": "RHEA-2012:0003", "date_type": "updated"}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '55' - Content-Type: - - application/json - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: POST - uri: https://foreman.example.org/katello/api/content_view_filters/17/rules - response: - body: - string: ' {"content_view_filter_id":17,"errata_id":"RHEA-2012:0003","date_type":"updated","id":5,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '168' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 201 - message: Created version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-15.yml b/tests/test_playbooks/fixtures/content_view_filter-15.yml index 154f0458e..e529f5953 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-15.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-15.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,18 +184,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Errata+id+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Package+Group+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Errata id Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":17,"name":"Test - Errata id Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Package Group Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":11,"name":"Test + Package Group Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:21 UTC","updated_at":"2023-11-15 09:55:21 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[{"content_view_filter_id":17,"errata_id":"RHEA-2012:0003","date_type":"updated","id":5,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[]}]} ' headers: @@ -204,7 +203,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1460' + - '1310' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -218,7 +217,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -248,17 +247,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/17 + uri: https://foreman.example.org/katello/api/content_views/10/filters/11 response: body: - string: ' {"inclusion":false,"id":17,"name":"Test Errata id Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":11,"name":"Test Package Group Content View + Filter","description":null,"created_at":"2023-11-15 09:55:21 UTC","updated_at":"2023-11-15 + 09:55:21 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[{"content_view_filter_id":17,"errata_id":"RHEA-2012:0003","date_type":"updated","id":5,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[]} ' headers: @@ -267,7 +266,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1439' + - '1286' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -281,7 +280,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -299,118 +298,4 @@ interactions: status: code: 200 message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/17/rules?errata_id=RHEA-2012%3A0003&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":null,"sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":17,"errata_id":"RHEA-2012:0003","date_type":"updated","id":5,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '311' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/17/rules/5 - response: - body: - string: ' {"content_view_filter_id":17,"errata_id":"RHEA-2012:0003","date_type":"updated","id":5,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '168' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-16.yml b/tests/test_playbooks/fixtures/content_view_filter-16.yml index 7bae0ceec..a62048fca 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-16.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-16.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,18 +184,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Errata+id+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Package+Group+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Errata id Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":17,"name":"Test - Errata id Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Package Group Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":11,"name":"Test + Package Group Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:21 UTC","updated_at":"2023-11-15 09:55:21 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[{"content_view_filter_id":17,"errata_id":"RHEA-2012:0003","date_type":"updated","id":5,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[]}]} ' headers: @@ -204,7 +203,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1460' + - '1310' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -218,7 +217,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -248,17 +247,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/17 + uri: https://foreman.example.org/katello/api/content_views/10/filters/11 response: body: - string: ' {"inclusion":false,"id":17,"name":"Test Errata id Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":11,"name":"Test Package Group Content View + Filter","description":null,"created_at":"2023-11-15 09:55:21 UTC","updated_at":"2023-11-15 + 09:55:21 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[{"content_view_filter_id":17,"errata_id":"RHEA-2012:0003","date_type":"updated","id":5,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[]} ' headers: @@ -267,7 +266,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1439' + - '1286' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -281,7 +280,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -313,16 +312,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: DELETE - uri: https://foreman.example.org/katello/api/content_views/8/filters/17 + uri: https://foreman.example.org/katello/api/content_views/10/filters/11 response: body: - string: ' {"inclusion":false,"id":17,"name":"Test Errata id Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:36 UTC","updated_at":"2023-06-04 21:32:36 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":11,"name":"Test Package Group Content View + Filter","description":null,"created_at":"2023-11-15 09:55:21 UTC","updated_at":"2023-11-15 + 09:55:21 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[]} ' headers: @@ -331,7 +331,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1275' + - '1287' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -345,7 +345,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: diff --git a/tests/test_playbooks/fixtures/content_view_filter-17.yml b/tests/test_playbooks/fixtures/content_view_filter-17.yml index 6c04ce6f7..0a7b8fbf7 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-17.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-17.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1049' + - '1050' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,134 +184,11 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Errata+date+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Docker+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Errata date Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} + Docker Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} ' headers: @@ -320,7 +197,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '191' + - '186' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -334,9 +211,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=95 + - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -353,8 +230,8 @@ interactions: code: 200 message: OK - request: - body: '{"name": "Test Errata date Content View Filter", "type": "erratum", "inclusion": - false, "repository_ids": [11]}' + body: '{"name": "Test Docker Content View Filter", "type": "docker", "inclusion": + false, "repository_ids": []}' headers: Accept: - application/json;version=2 @@ -363,29 +240,22 @@ interactions: Connection: - keep-alive Content-Length: - - '111' + - '103' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/content_views/8/filters + uri: https://foreman.example.org/katello/api/content_views/10/filters response: body: - string: ' {"inclusion":false,"id":18,"name":"Test Errata date Content View - Filter","description":null,"created_at":"2023-06-04 21:32:39 UTC","updated_at":"2023-06-04 - 21:32:39 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":12,"name":"Test Docker Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:24 UTC","updated_at":"2023-11-15 09:55:24 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"erratum","rules":[]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[]} ' headers: @@ -394,7 +264,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '2919' + - '1272' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -408,71 +278,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 201 - message: Created -- request: - body: '{"start_date": "2017-01-03", "end_date": "2018-01-03", "types": ["bugfix", - "enhancement", "security"], "date_type": "updated"}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '126' - Content-Type: - - application/json - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: POST - uri: https://foreman.example.org/katello/api/content_view_filters/18/rules - response: - body: - string: ' {"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:40 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '233' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 + - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: diff --git a/tests/test_playbooks/fixtures/content_view_filter-18.yml b/tests/test_playbooks/fixtures/content_view_filter-18.yml index 593fc1a25..0a9eb24ea 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-18.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-18.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,147 +184,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Docker+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Errata+date+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Errata date Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":18,"name":"Test - Errata date Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:39 UTC","updated_at":"2023-06-04 21:32:39 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Docker Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":12,"name":"Test + Docker Content View Filter","description":null,"created_at":"2023-11-15 09:55:24 + UTC","updated_at":"2023-11-15 09:55:24 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"erratum","rules":[{"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:40 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[]}]} ' headers: @@ -333,7 +203,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3172' + - '1289' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,9 +217,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=95 + - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -377,81 +247,16 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/18 + uri: https://foreman.example.org/katello/api/content_views/10/filters/12 response: body: - string: ' {"inclusion":false,"id":18,"name":"Test Errata date Content View - Filter","description":null,"created_at":"2023-06-04 21:32:39 UTC","updated_at":"2023-06-04 - 21:32:39 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":12,"name":"Test Docker Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:24 UTC","updated_at":"2023-11-15 09:55:24 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"erratum","rules":[{"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:40 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '3149' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/18/rules?per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":null,"sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:40 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[]} ' headers: @@ -460,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '376' + - '1272' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -474,66 +279,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/18/rules/6 - response: - body: - string: ' {"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:40 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '233' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 + - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: diff --git a/tests/test_playbooks/fixtures/content_view_filter-19.yml b/tests/test_playbooks/fixtures/content_view_filter-19.yml index db1f673ea..f36ce96e6 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-19.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-19.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,147 +184,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Docker+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Errata+date+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Errata date Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":18,"name":"Test - Errata date Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:39 UTC","updated_at":"2023-06-04 21:32:39 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Docker Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":12,"name":"Test + Docker Content View Filter","description":null,"created_at":"2023-11-15 09:55:24 + UTC","updated_at":"2023-11-15 09:55:24 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"erratum","rules":[{"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:40 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[]}]} ' headers: @@ -333,7 +203,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3172' + - '1289' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,9 +217,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=95 + - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -377,24 +247,16 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/18 + uri: https://foreman.example.org/katello/api/content_views/10/filters/12 response: body: - string: ' {"inclusion":false,"id":18,"name":"Test Errata date Content View - Filter","description":null,"created_at":"2023-06-04 21:32:39 UTC","updated_at":"2023-06-04 - 21:32:39 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":12,"name":"Test Docker Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:24 UTC","updated_at":"2023-11-15 09:55:24 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"erratum","rules":[{"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:40 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[]} ' headers: @@ -403,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3149' + - '1272' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,66 +279,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/18/rules?per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":null,"sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:40 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '376' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 + - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -501,75 +306,21 @@ interactions: - gzip, deflate Connection: - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/18/rules/6 - response: - body: - string: ' {"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:40 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive Content-Length: - - '233' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: '{"date_type": "issued"}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '23' - Content-Type: - - application/json + - '0' User-Agent: - apypie (https://github.com/Apipie/apypie) - method: PUT - uri: https://foreman.example.org/katello/api/content_view_filters/18/rules/6 + method: DELETE + uri: https://foreman.example.org/katello/api/content_views/10/filters/12 response: body: - string: ' {"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"issued","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:42 UTC"} + string: ' {"inclusion":false,"id":12,"name":"Test Docker Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:24 UTC","updated_at":"2023-11-15 09:55:24 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[]} ' headers: @@ -578,7 +329,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '232' + - '1273' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -592,9 +343,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=91 + - timeout=15, max=95 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: diff --git a/tests/test_playbooks/fixtures/content_view_filter-2.yml b/tests/test_playbooks/fixtures/content_view_filter-2.yml index 5c7b84ea1..2f19f4621 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-2.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-2.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -188,9 +188,9 @@ interactions: response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"less than + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' @@ -200,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '690' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -214,7 +214,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -244,17 +244,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"org_repository_count":3} ' headers: @@ -263,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1838' + - '2056' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -277,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -307,24 +309,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:17 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:10 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]}]} ' headers: @@ -333,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3058' + - '3148' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,7 +350,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -377,24 +380,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/8 response: body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:17 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"original_packages":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:10 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]} ' headers: @@ -403,7 +407,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3065' + - '3156' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,7 +421,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -451,24 +455,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: PUT - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/8 response: body: - string: ' {"inclusion":false,"original_packages":true,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:19 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"original_packages":true,"id":8,"name":"Test Package + Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:11 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]} ' headers: @@ -477,7 +482,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3064' + - '3155' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -491,7 +496,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=93 Strict-Transport-Security: @@ -509,118 +514,4 @@ interactions: status: code: 200 message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '285' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 - response: - body: - string: ' {"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '131' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=91 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-20.yml b/tests/test_playbooks/fixtures/content_view_filter-20.yml index 8b06c7c7c..e3ea8a48c 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-20.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-20.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1050' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,14 +184,11 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Content+View+Filter+-+modulemd%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} + string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Content View Filter - modulemd\"","sort":{"by":"name","order":"asc"},"results":[]} ' headers: @@ -200,324 +197,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Errata+date+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Errata date Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":18,"name":"Test - Errata date Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:39 UTC","updated_at":"2023-06-04 21:32:39 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"erratum","rules":[{"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"issued","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:42 UTC"}]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '3171' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/18 - response: - body: - string: ' {"inclusion":false,"id":18,"name":"Test Errata date Content View - Filter","description":null,"created_at":"2023-06-04 21:32:39 UTC","updated_at":"2023-06-04 - 21:32:39 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"erratum","rules":[{"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"issued","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:42 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '3148' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/18/rules?per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":null,"sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"issued","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:42 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '375' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/18/rules/6 - response: - body: - string: ' {"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["bugfix","enhancement","security"],"date_type":"issued","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:42 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '232' + - '190' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -531,9 +211,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=92 + - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -550,7 +230,8 @@ interactions: code: 200 message: OK - request: - body: '{"types": ["security"], "date_type": "updated"}' + body: '{"name": "Test Content View Filter - modulemd", "type": "modulemd", "inclusion": + false, "repository_ids": []}' headers: Accept: - application/json;version=2 @@ -559,17 +240,23 @@ interactions: Connection: - keep-alive Content-Length: - - '47' + - '109' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) - method: PUT - uri: https://foreman.example.org/katello/api/content_view_filters/18/rules/6 + method: POST + uri: https://foreman.example.org/katello/api/content_views/10/filters response: body: - string: ' {"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:44 UTC"} + string: ' {"inclusion":false,"original_module_streams":false,"id":13,"name":"Test + Content View Filter - modulemd","description":null,"created_at":"2023-11-15 + 09:55:26 UTC","updated_at":"2023-11-15 09:55:26 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]} ' headers: @@ -578,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '210' + - '1310' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -592,9 +279,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=91 + - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -608,6 +295,6 @@ interactions: X-XSS-Protection: - 1; mode=block status: - code: 200 - message: OK + code: 201 + message: Created version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-21.yml b/tests/test_playbooks/fixtures/content_view_filter-21.yml index bf1310086..09268d1f7 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-21.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-21.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,147 +184,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Content+View+Filter+-+modulemd%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Errata+date+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Errata date Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":18,"name":"Test - Errata date Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:39 UTC","updated_at":"2023-06-04 21:32:39 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View Filter - modulemd\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":13,"name":"Test + Content View Filter - modulemd","description":null,"created_at":"2023-11-15 + 09:55:26 UTC","updated_at":"2023-11-15 09:55:26 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"erratum","rules":[{"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:44 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]}]} ' headers: @@ -333,7 +203,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3149' + - '1299' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,9 +217,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=95 + - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -377,24 +247,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/18 + uri: https://foreman.example.org/katello/api/content_views/10/filters/13 response: body: - string: ' {"inclusion":false,"id":18,"name":"Test Errata date Content View - Filter","description":null,"created_at":"2023-06-04 21:32:39 UTC","updated_at":"2023-06-04 - 21:32:39 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"original_module_streams":false,"id":13,"name":"Test + Content View Filter - modulemd","description":null,"created_at":"2023-11-15 + 09:55:26 UTC","updated_at":"2023-11-15 09:55:26 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"erratum","rules":[{"content_view_filter_id":18,"start_date":"2017-01-03","end_date":"2018-01-03","types":["security"],"date_type":"updated","id":6,"created_at":"2023-06-04 - 21:32:40 UTC","updated_at":"2023-06-04 21:32:44 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]} ' headers: @@ -403,7 +266,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3126' + - '1310' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,74 +280,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '0' - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: DELETE - uri: https://foreman.example.org/katello/api/content_views/8/filters/18 - response: - body: - string: ' {"inclusion":false,"id":18,"name":"Test Errata date Content View - Filter","description":null,"created_at":"2023-06-04 21:32:39 UTC","updated_at":"2023-06-04 - 21:32:39 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1277' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 + - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: diff --git a/tests/test_playbooks/fixtures/content_view_filter-22.yml b/tests/test_playbooks/fixtures/content_view_filter-22.yml index 8894a890f..51d44b2d1 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-22.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-22.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,11 +184,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Group+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Content+View+Filter+-+modulemd%22&per_page=4294967296 response: body: - string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Group Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} + string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Content View Filter - modulemd\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":13,"name":"Test + Content View Filter - modulemd","description":null,"created_at":"2023-11-15 + 09:55:26 UTC","updated_at":"2023-11-15 09:55:26 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]}]} ' headers: @@ -197,7 +203,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '193' + - '1299' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -211,7 +217,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -230,8 +236,7 @@ interactions: code: 200 message: OK - request: - body: '{"name": "Test Package Group Content View Filter", "type": "package_group", - "inclusion": false, "repository_ids": []}' + body: null headers: Accept: - application/json;version=2 @@ -239,24 +244,20 @@ interactions: - gzip, deflate Connection: - keep-alive - Content-Length: - - '117' - Content-Type: - - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) - method: POST - uri: https://foreman.example.org/katello/api/content_views/8/filters + method: GET + uri: https://foreman.example.org/katello/api/content_views/10/filters/13 response: body: - string: ' {"inclusion":false,"id":19,"name":"Test Package Group Content View - Filter","description":null,"created_at":"2023-06-04 21:32:46 UTC","updated_at":"2023-06-04 - 21:32:46 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"original_module_streams":false,"id":13,"name":"Test + Content View Filter - modulemd","description":null,"created_at":"2023-11-15 + 09:55:26 UTC","updated_at":"2023-11-15 09:55:26 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]} ' headers: @@ -265,7 +266,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1284' + - '1310' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -279,7 +280,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -294,63 +295,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - status: - code: 201 - message: Created -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/package_groups?organization_id=5&search=name%3D%22birds%22&per_page=4294967296 - response: - body: - string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"birds\"","sort":{"by":"name","order":"asc"},"results":[{"id":2,"name":"birds","pulp_id":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","uuid":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","description":"","repository":{"id":11,"name":"Test - Repository","product":{"id":4,"name":"Test Product"}}}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '464' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block status: code: 200 message: OK @@ -363,75 +307,22 @@ interactions: - gzip, deflate Connection: - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/package_groups/2?organization_id=5 - response: - body: - string: ' {"id":2,"name":"birds","pulp_id":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","uuid":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","description":"","repository":{"id":11,"name":"Test - Repository","product":{"id":4,"name":"Test Product"}},"default_package_names":[],"mandatory_package_names":["cockateel","duck","penguin","stork"],"conditional_package_names":[],"optional_package_names":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive Content-Length: - - '458' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: '{"name": "birds", "uuid": "/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/"}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '105' - Content-Type: - - application/json + - '0' User-Agent: - apypie (https://github.com/Apipie/apypie) - method: POST - uri: https://foreman.example.org/katello/api/content_view_filters/19/rules + method: DELETE + uri: https://foreman.example.org/katello/api/content_views/10/filters/13 response: body: - string: ' {"content_view_filter_id":19,"uuid":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","id":3,"name":"birds","created_at":"2023-06-04 - 21:32:46 UTC","updated_at":"2023-06-04 21:32:46 UTC"} + string: ' {"inclusion":false,"original_module_streams":false,"id":13,"name":"Test + Content View Filter - modulemd","description":null,"created_at":"2023-11-15 + 09:55:26 UTC","updated_at":"2023-11-15 09:55:26 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]} ' headers: @@ -440,7 +331,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '218' + - '1311' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -454,9 +345,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=93 + - timeout=15, max=95 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -470,6 +361,6 @@ interactions: X-XSS-Protection: - 1; mode=block status: - code: 201 - message: Created + code: 200 + message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-23.yml b/tests/test_playbooks/fixtures/content_view_filter-23.yml index d6bb743d8..fea5f028f 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-23.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-23.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1050' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,18 +184,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Group+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Group Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":19,"name":"Test - Package Group Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:46 UTC","updated_at":"2023-06-04 21:32:46 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[{"content_view_filter_id":19,"uuid":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","id":3,"name":"birds","created_at":"2023-06-04 - 21:32:46 UTC","updated_at":"2023-06-04 21:32:46 UTC"}]}]} + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than + a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' headers: @@ -204,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1524' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -216,9 +212,9 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - ; ANY + - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -248,18 +244,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/19 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: - string: ' {"inclusion":false,"id":19,"name":"Test Package Group Content View - Filter","description":null,"created_at":"2023-06-04 21:32:46 UTC","updated_at":"2023-06-04 - 21:32:46 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[{"content_view_filter_id":19,"uuid":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","id":3,"name":"birds","created_at":"2023-06-04 - 21:32:46 UTC","updated_at":"2023-06-04 21:32:46 UTC"}]} + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"org_repository_count":3} ' headers: @@ -268,7 +263,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1499' + - '1869' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -282,7 +277,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -312,11 +307,11 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/19/rules?search=name%3D%22birds%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Deb+Content+View+Filter%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"birds\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":19,"uuid":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","id":3,"name":"birds","created_at":"2023-06-04 - 21:32:46 UTC","updated_at":"2023-06-04 21:32:46 UTC"}]} + string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Deb Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} ' headers: @@ -325,7 +320,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '373' + - '183' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -339,7 +334,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -358,7 +353,8 @@ interactions: code: 200 message: OK - request: - body: null + body: '{"name": "Test Deb Content View Filter", "type": "deb", "inclusion": false, + "repository_ids": [18]}' headers: Accept: - application/json;version=2 @@ -366,71 +362,31 @@ interactions: - gzip, deflate Connection: - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/19/rules/3 - response: - body: - string: ' {"content_view_filter_id":19,"uuid":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","id":3,"name":"birds","created_at":"2023-06-04 - 21:32:46 UTC","updated_at":"2023-06-04 21:32:46 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive Content-Length: - - '218' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' + - '99' Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive + - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/package_groups?organization_id=5&search=name%3D%22birds%22&per_page=4294967296 + method: POST + uri: https://foreman.example.org/katello/api/content_views/10/filters response: body: - string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"birds\"","sort":{"by":"name","order":"asc"},"results":[{"id":2,"name":"birds","pulp_id":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","uuid":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","description":"","repository":{"id":11,"name":"Test - Repository","product":{"id":4,"name":"Test Product"}}}]} + string: ' {"inclusion":false,"id":14,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:28 UTC","updated_at":"2023-11-15 09:55:28 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":14,"content_view_filter_name":"Test + Deb Content View Filter","content_view_id":10,"content_view_name":"Test Content + View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"type":"deb","rules":[]} ' headers: @@ -439,7 +395,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '464' + - '3114' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -451,68 +407,11 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/package_groups/2?organization_id=5 - response: - body: - string: ' {"id":2,"name":"birds","pulp_id":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","uuid":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","description":"","repository":{"id":11,"name":"Test - Repository","product":{"id":4,"name":"Test Product"}},"default_package_names":[],"mandatory_package_names":["cockateel","duck","penguin","stork"],"conditional_package_names":[],"optional_package_names":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '458' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - ; ANY - Foreman_current_organization: - - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=92 + - timeout=15, max=94 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -526,6 +425,6 @@ interactions: X-XSS-Protection: - 1; mode=block status: - code: 200 - message: OK + code: 201 + message: Created version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-24.yml b/tests/test_playbooks/fixtures/content_view_filter-24.yml index 51220a537..bab95ebad 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-24.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-24.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,18 +184,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Group+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Group Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":19,"name":"Test - Package Group Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:46 UTC","updated_at":"2023-06-04 21:32:46 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[{"content_view_filter_id":19,"uuid":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","id":3,"name":"birds","created_at":"2023-06-04 - 21:32:46 UTC","updated_at":"2023-06-04 21:32:46 UTC"}]}]} + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' headers: @@ -204,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1524' + - '681' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -216,9 +212,9 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - ; ANY + - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -248,18 +244,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/19 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: - string: ' {"inclusion":false,"id":19,"name":"Test Package Group Content View - Filter","description":null,"created_at":"2023-06-04 21:32:46 UTC","updated_at":"2023-06-04 - 21:32:46 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[{"content_view_filter_id":19,"uuid":"/pulp/api/v3/content/rpm/packagegroups/86fae512-5a7b-4f10-956c-df69a9218856/","id":3,"name":"birds","created_at":"2023-06-04 - 21:32:46 UTC","updated_at":"2023-06-04 21:32:46 UTC"}]} + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":14,"content_view_filter_name":"Test + Deb Content View Filter","content_view_id":10,"content_view_name":"Test Content + View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"org_repository_count":3} ' headers: @@ -268,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1499' + - '2043' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -282,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -309,22 +306,28 @@ interactions: - gzip, deflate Connection: - keep-alive - Content-Length: - - '0' User-Agent: - apypie (https://github.com/Apipie/apypie) - method: DELETE - uri: https://foreman.example.org/katello/api/content_views/8/filters/19 + method: GET + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Deb+Content+View+Filter%22&per_page=4294967296 response: body: - string: ' {"inclusion":false,"id":19,"name":"Test Package Group Content View - Filter","description":null,"created_at":"2023-06-04 21:32:46 UTC","updated_at":"2023-06-04 - 21:32:46 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test + string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Deb Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":14,"name":"Test + Deb Content View Filter","description":null,"created_at":"2023-11-15 09:55:28 + UTC","updated_at":"2023-11-15 09:55:28 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"package_group","rules":[]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":14,"content_view_filter_name":"Test + Deb Content View Filter","content_view_id":10,"content_view_name":"Test Content + View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"type":"deb","rules":[]}]} ' headers: @@ -333,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1285' + - '3128' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,7 +350,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -365,4 +368,74 @@ interactions: status: code: 200 message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/content_views/10/filters/14 + response: + body: + string: ' {"inclusion":false,"id":14,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:28 UTC","updated_at":"2023-11-15 09:55:28 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":14,"content_view_filter_name":"Test + Deb Content View Filter","content_view_id":10,"content_view_name":"Test Content + View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"type":"deb","rules":[]} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '3114' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.7.1 + Keep-Alive: + - timeout=15, max=94 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-25.yml b/tests/test_playbooks/fixtures/content_view_filter-25.yml index 8bfe6e1ba..e94e4b2e7 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-25.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-25.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,11 +184,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Docker+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 response: body: - string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Docker Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} + string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' headers: @@ -197,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '186' + - '681' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -209,9 +212,9 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - ; ANY + - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -230,8 +233,7 @@ interactions: code: 200 message: OK - request: - body: '{"name": "Test Docker Content View Filter", "type": "docker", "inclusion": - false, "repository_ids": []}' + body: null headers: Accept: - application/json;version=2 @@ -239,23 +241,93 @@ interactions: - gzip, deflate Connection: - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + response: + body: + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":14,"content_view_filter_name":"Test + Deb Content View Filter","content_view_id":10,"content_view_name":"Test Content + View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"org_repository_count":3} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive Content-Length: - - '103' + - '2043' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - - application/json + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.7.1 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive User-Agent: - apypie (https://github.com/Apipie/apypie) - method: POST - uri: https://foreman.example.org/katello/api/content_views/8/filters + method: GET + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Deb+Content+View+Filter%22&per_page=4294967296 response: body: - string: ' {"inclusion":false,"id":20,"name":"Test Docker Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:50 UTC","updated_at":"2023-06-04 21:32:50 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Deb Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":14,"name":"Test + Deb Content View Filter","description":null,"created_at":"2023-11-15 09:55:28 + UTC","updated_at":"2023-11-15 09:55:28 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":14,"content_view_filter_name":"Test + Deb Content View Filter","content_view_id":10,"content_view_name":"Test Content + View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"type":"deb","rules":[]}]} ' headers: @@ -264,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1270' + - '3128' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -278,9 +350,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=96 + - timeout=15, max=95 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -294,10 +366,10 @@ interactions: X-XSS-Protection: - 1; mode=block status: - code: 201 - message: Created + code: 200 + message: OK - request: - body: '{"name": "birds"}' + body: null headers: Accept: - application/json;version=2 @@ -305,18 +377,101 @@ interactions: - gzip, deflate Connection: - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/content_views/10/filters/14 + response: + body: + string: ' {"inclusion":false,"id":14,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:28 UTC","updated_at":"2023-11-15 09:55:28 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":14,"content_view_filter_name":"Test + Deb Content View Filter","content_view_id":10,"content_view_name":"Test Content + View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"type":"deb","rules":[]} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive Content-Length: - - '17' + - '3114' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.7.1 + Keep-Alive: + - timeout=15, max=94 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: '{"inclusion": true}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '19' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) - method: POST - uri: https://foreman.example.org/katello/api/content_view_filters/20/rules + method: PUT + uri: https://foreman.example.org/katello/api/content_views/10/filters/14 response: body: - string: ' {"content_view_filter_id":20,"id":3,"name":"birds","created_at":"2023-06-04 - 21:32:50 UTC","updated_at":"2023-06-04 21:32:50 UTC"} + string: ' {"inclusion":true,"id":14,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:28 UTC","updated_at":"2023-11-15 09:55:30 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":14,"content_view_filter_name":"Test + Deb Content View Filter","content_view_id":10,"content_view_name":"Test Content + View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"type":"deb","rules":[]} ' headers: @@ -325,7 +480,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '132' + - '3113' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -339,9 +494,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=95 + - timeout=15, max=93 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -355,6 +510,6 @@ interactions: X-XSS-Protection: - 1; mode=block status: - code: 201 - message: Created + code: 200 + message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-26.yml b/tests/test_playbooks/fixtures/content_view_filter-26.yml index f7142f18b..e9042ad32 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-26.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-26.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,18 +184,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Docker+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Docker Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":20,"name":"Test - Docker Content View Filter","description":null,"created_at":"2023-06-04 21:32:50 - UTC","updated_at":"2023-06-04 21:32:50 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[{"content_view_filter_id":20,"id":3,"name":"birds","created_at":"2023-06-04 - 21:32:50 UTC","updated_at":"2023-06-04 21:32:50 UTC"}]}]} + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' headers: @@ -204,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1417' + - '681' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -216,9 +212,9 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - ; ANY + - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -248,17 +244,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/20 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: - string: ' {"inclusion":false,"id":20,"name":"Test Docker Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:50 UTC","updated_at":"2023-06-04 21:32:50 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[{"content_view_filter_id":20,"id":3,"name":"birds","created_at":"2023-06-04 - 21:32:50 UTC","updated_at":"2023-06-04 21:32:50 UTC"}]} + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":14,"content_view_filter_name":"Test + Deb Content View Filter","content_view_id":10,"content_view_name":"Test Content + View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"org_repository_count":3} ' headers: @@ -267,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1399' + - '2043' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -281,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -311,11 +309,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/20/rules?search=name%3D%22birds%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Deb+Content+View+Filter%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"birds\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":20,"id":3,"name":"birds","created_at":"2023-06-04 - 21:32:50 UTC","updated_at":"2023-06-04 21:32:50 UTC"}]} + string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Deb Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":true,"id":14,"name":"Test + Deb Content View Filter","description":null,"created_at":"2023-11-15 09:55:28 + UTC","updated_at":"2023-11-15 09:55:30 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":14,"content_view_filter_name":"Test + Deb Content View Filter","content_view_id":10,"content_view_name":"Test Content + View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"type":"deb","rules":[]}]} ' headers: @@ -324,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '287' + - '3127' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -338,7 +350,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -368,11 +380,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/20/rules/3 + uri: https://foreman.example.org/katello/api/content_views/10/filters/14 response: body: - string: ' {"content_view_filter_id":20,"id":3,"name":"birds","created_at":"2023-06-04 - 21:32:50 UTC","updated_at":"2023-06-04 21:32:50 UTC"} + string: ' {"inclusion":true,"id":14,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:28 UTC","updated_at":"2023-11-15 09:55:30 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":14,"content_view_filter_name":"Test + Deb Content View Filter","content_view_id":10,"content_view_name":"Test Content + View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 + minute"}],"type":"deb","rules":[]} ' headers: @@ -381,7 +406,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '132' + - '3113' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -395,7 +420,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -413,4 +438,68 @@ interactions: status: code: 200 message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '0' + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: DELETE + uri: https://foreman.example.org/katello/api/content_views/10/filters/14 + response: + body: + string: ' {"inclusion":true,"id":14,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:28 UTC","updated_at":"2023-11-15 09:55:30 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"deb","rules":[]} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '1266' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.7.1 + Keep-Alive: + - timeout=15, max=93 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-27.yml b/tests/test_playbooks/fixtures/content_view_filter-27.yml deleted file mode 100644 index bea6b8572..000000000 --- a/tests/test_playbooks/fixtures/content_view_filter-27.yml +++ /dev/null @@ -1,366 +0,0 @@ -interactions: -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/api/status - response: - body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '66' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=100 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 - response: - body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": - 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test - Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '388' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=99 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 - response: - body: - string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1048' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=98 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Docker+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Docker Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":20,"name":"Test - Docker Content View Filter","description":null,"created_at":"2023-06-04 21:32:50 - UTC","updated_at":"2023-06-04 21:32:50 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[{"content_view_filter_id":20,"id":3,"name":"birds","created_at":"2023-06-04 - 21:32:50 UTC","updated_at":"2023-06-04 21:32:50 UTC"}]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1417' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/20 - response: - body: - string: ' {"inclusion":false,"id":20,"name":"Test Docker Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:50 UTC","updated_at":"2023-06-04 21:32:50 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[{"content_view_filter_id":20,"id":3,"name":"birds","created_at":"2023-06-04 - 21:32:50 UTC","updated_at":"2023-06-04 21:32:50 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1399' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '0' - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: DELETE - uri: https://foreman.example.org/katello/api/content_views/8/filters/20 - response: - body: - string: ' {"inclusion":false,"id":20,"name":"Test Docker Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:50 UTC","updated_at":"2023-06-04 21:32:50 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"docker","rules":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1271' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-28.yml b/tests/test_playbooks/fixtures/content_view_filter-28.yml deleted file mode 100644 index 20d70d2c8..000000000 --- a/tests/test_playbooks/fixtures/content_view_filter-28.yml +++ /dev/null @@ -1,300 +0,0 @@ -interactions: -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/api/status - response: - body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '66' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=100 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 - response: - body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": - 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test - Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '388' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=99 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 - response: - body: - string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1049' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=98 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Content+View+Filter+-+modulemd%22&per_page=4294967296 - response: - body: - string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View Filter - modulemd\"","sort":{"by":"name","order":"asc"},"results":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '190' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: '{"name": "Test Content View Filter - modulemd", "type": "modulemd", "inclusion": - false, "repository_ids": []}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '109' - Content-Type: - - application/json - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: POST - uri: https://foreman.example.org/katello/api/content_views/8/filters - response: - body: - string: ' {"inclusion":false,"original_module_streams":false,"id":21,"name":"Test - Content View Filter - modulemd","description":null,"created_at":"2023-06-04 - 21:32:53 UTC","updated_at":"2023-06-04 21:32:53 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1308' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 201 - message: Created -version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-3.yml b/tests/test_playbooks/fixtures/content_view_filter-3.yml index 220485d50..cc1ff58f3 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-3.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-3.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -188,9 +188,9 @@ interactions: response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"less than + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' @@ -200,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '690' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -214,7 +214,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -244,17 +244,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"org_repository_count":3} ' headers: @@ -263,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1838' + - '2056' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -277,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -307,24 +309,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:19 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:11 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]}]} ' headers: @@ -333,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3058' + - '3148' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,7 +350,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -377,24 +380,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/8 response: body: - string: ' {"inclusion":false,"original_packages":true,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:19 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"original_packages":true,"id":8,"name":"Test Package + Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:11 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]} ' headers: @@ -403,7 +407,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3064' + - '3155' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,7 +421,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -435,118 +439,4 @@ interactions: status: code: 200 message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '285' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 - response: - body: - string: ' {"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '131' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-30.yml b/tests/test_playbooks/fixtures/content_view_filter-30.yml deleted file mode 100644 index 2700014b4..000000000 --- a/tests/test_playbooks/fixtures/content_view_filter-30.yml +++ /dev/null @@ -1,366 +0,0 @@ -interactions: -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/api/status - response: - body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '66' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=100 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 - response: - body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": - 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test - Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '388' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=99 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 - response: - body: - string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1048' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=98 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Content+View+Filter+-+modulemd%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View Filter - modulemd\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":21,"name":"Test - Content View Filter - modulemd","description":null,"created_at":"2023-06-04 - 21:32:53 UTC","updated_at":"2023-06-04 21:32:53 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1298' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/21 - response: - body: - string: ' {"inclusion":false,"original_module_streams":false,"id":21,"name":"Test - Content View Filter - modulemd","description":null,"created_at":"2023-06-04 - 21:32:53 UTC","updated_at":"2023-06-04 21:32:53 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1308' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '0' - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: DELETE - uri: https://foreman.example.org/katello/api/content_views/8/filters/21 - response: - body: - string: ' {"inclusion":false,"original_module_streams":false,"id":21,"name":"Test - Content View Filter - modulemd","description":null,"created_at":"2023-06-04 - 21:32:53 UTC","updated_at":"2023-06-04 21:32:53 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1309' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-31.yml b/tests/test_playbooks/fixtures/content_view_filter-31.yml deleted file mode 100644 index 8b3712841..000000000 --- a/tests/test_playbooks/fixtures/content_view_filter-31.yml +++ /dev/null @@ -1,428 +0,0 @@ -interactions: -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/api/status - response: - body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '66' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=100 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 - response: - body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": - 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test - Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '388' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=99 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 - response: - body: - string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1049' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=98 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Deb+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Deb Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '183' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: '{"name": "Test Deb Content View Filter", "type": "deb", "inclusion": false, - "repository_ids": [11]}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '99' - Content-Type: - - application/json - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: POST - uri: https://foreman.example.org/katello/api/content_views/8/filters - response: - body: - string: ' {"inclusion":false,"id":22,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:56 UTC","updated_at":"2023-06-04 21:32:56 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"deb","rules":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '2907' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 201 - message: Created -version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-32.yml b/tests/test_playbooks/fixtures/content_view_filter-32.yml deleted file mode 100644 index 61bf8bf83..000000000 --- a/tests/test_playbooks/fixtures/content_view_filter-32.yml +++ /dev/null @@ -1,435 +0,0 @@ -interactions: -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/api/status - response: - body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '66' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=100 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 - response: - body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": - 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test - Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '388' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=99 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 - response: - body: - string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1048' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=98 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Deb+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Deb Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":22,"name":"Test - Deb Content View Filter","description":null,"created_at":"2023-06-04 21:32:56 - UTC","updated_at":"2023-06-04 21:32:56 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"deb","rules":[]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '2922' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/22 - response: - body: - string: ' {"inclusion":false,"id":22,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:56 UTC","updated_at":"2023-06-04 21:32:56 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"deb","rules":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '2907' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-33.yml b/tests/test_playbooks/fixtures/content_view_filter-33.yml deleted file mode 100644 index 6f1ced8e8..000000000 --- a/tests/test_playbooks/fixtures/content_view_filter-33.yml +++ /dev/null @@ -1,507 +0,0 @@ -interactions: -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/api/status - response: - body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '66' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=100 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 - response: - body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": - 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test - Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '388' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=99 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 - response: - body: - string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1048' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=98 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Deb+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Deb Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":22,"name":"Test - Deb Content View Filter","description":null,"created_at":"2023-06-04 21:32:56 - UTC","updated_at":"2023-06-04 21:32:56 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"deb","rules":[]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '2922' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/22 - response: - body: - string: ' {"inclusion":false,"id":22,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:56 UTC","updated_at":"2023-06-04 21:32:56 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"deb","rules":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '2907' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: '{"inclusion": true}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '19' - Content-Type: - - application/json - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: PUT - uri: https://foreman.example.org/katello/api/content_views/8/filters/22 - response: - body: - string: ' {"inclusion":true,"id":22,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:56 UTC","updated_at":"2023-06-04 21:32:59 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"deb","rules":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '2906' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-34.yml b/tests/test_playbooks/fixtures/content_view_filter-34.yml deleted file mode 100644 index 90ba962ea..000000000 --- a/tests/test_playbooks/fixtures/content_view_filter-34.yml +++ /dev/null @@ -1,499 +0,0 @@ -interactions: -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/api/status - response: - body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '66' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=100 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 - response: - body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": - 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test - Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '388' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=99 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 - response: - body: - string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1048' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=98 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Deb+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Deb Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":true,"id":22,"name":"Test - Deb Content View Filter","description":null,"created_at":"2023-06-04 21:32:56 - UTC","updated_at":"2023-06-04 21:32:59 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"deb","rules":[]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '2921' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/22 - response: - body: - string: ' {"inclusion":true,"id":22,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:56 UTC","updated_at":"2023-06-04 21:32:59 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"deb","rules":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '2906' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '0' - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: DELETE - uri: https://foreman.example.org/katello/api/content_views/8/filters/22 - response: - body: - string: ' {"inclusion":true,"id":22,"name":"Test Deb Content View Filter","description":null,"created_at":"2023-06-04 - 21:32:56 UTC","updated_at":"2023-06-04 21:32:59 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"deb","rules":[]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1264' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-4.yml b/tests/test_playbooks/fixtures/content_view_filter-4.yml index fdb96b662..1eacb557d 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-4.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-4.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -188,9 +188,9 @@ interactions: response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"less than + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' @@ -200,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '690' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -214,7 +214,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -244,17 +244,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"org_repository_count":3} ' headers: @@ -263,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1838' + - '2056' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -277,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -307,24 +309,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:19 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:11 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]}]} ' headers: @@ -333,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3058' + - '3148' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,7 +350,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -377,24 +380,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/8 response: body: - string: ' {"inclusion":false,"original_packages":true,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:19 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"original_packages":true,"id":8,"name":"Test Package + Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:11 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]} ' headers: @@ -403,7 +407,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3064' + - '3155' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,7 +421,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -451,24 +455,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: PUT - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/8 response: body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"original_packages":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:13 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]} ' headers: @@ -477,7 +482,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3065' + - '3156' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -491,7 +496,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=93 Strict-Transport-Security: @@ -509,118 +514,4 @@ interactions: status: code: 200 message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '285' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 - response: - body: - string: ' {"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '131' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=91 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-5.yml b/tests/test_playbooks/fixtures/content_view_filter-5.yml index 227add005..a1ccd2fbe 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-5.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-5.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -188,9 +188,9 @@ interactions: response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"less than + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' @@ -200,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '690' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -214,7 +214,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -244,17 +244,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"org_repository_count":3} ' headers: @@ -263,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1838' + - '2056' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -277,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -307,24 +309,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:13 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]}]} ' headers: @@ -333,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3058' + - '3148' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,7 +350,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -377,24 +380,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/8 response: body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"original_packages":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:13 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]} ' headers: @@ -403,7 +407,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3065' + - '3156' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,7 +421,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -435,118 +439,4 @@ interactions: status: code: 200 message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '285' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 - response: - body: - string: ' {"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '131' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-6.yml b/tests/test_playbooks/fixtures/content_view_filter-6.yml index 384a34173..8e5f4e59e 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-6.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-6.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -188,9 +188,9 @@ interactions: response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"less than + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' @@ -200,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '690' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -214,7 +214,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -244,17 +244,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"org_repository_count":3} ' headers: @@ -263,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1838' + - '2056' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -277,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -307,24 +309,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:13 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]}]} ' headers: @@ -333,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3058' + - '3148' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,7 +350,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -377,24 +380,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/8 response: body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"original_packages":false,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:13 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]} ' headers: @@ -403,7 +407,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3065' + - '3156' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,7 +421,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -436,7 +440,7 @@ interactions: code: 200 message: OK - request: - body: null + body: '{"inclusion": true}' headers: Accept: - application/json;version=2 @@ -444,132 +448,32 @@ interactions: - gzip, deflate Connection: - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive Content-Length: - - '285' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 - response: - body: - string: ' {"content_view_filter_id":16,"id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:17 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '131' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: '{"version": "1"}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Content-Length: - - '16' + - '19' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: PUT - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 + uri: https://foreman.example.org/katello/api/content_views/10/filters/8 response: body: - string: ' {"content_view_filter_id":16,"version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:25 UTC"} + string: ' {"inclusion":true,"original_packages":false,"id":8,"name":"Test Package + Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:15 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"type":"rpm","rules":[]} ' headers: @@ -578,7 +482,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '145' + - '3155' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -592,9 +496,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=91 + - timeout=15, max=93 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: diff --git a/tests/test_playbooks/fixtures/content_view_filter-7.yml b/tests/test_playbooks/fixtures/content_view_filter-7.yml index 4426b7737..e9bc85193 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-7.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-7.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -188,10 +188,10 @@ interactions: response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":10,"cp_id":"347380074197","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} + Complete.","last_sync":"2023-11-15 09:54:59 UTC","last_sync_words":"less than + a minute","organization_id":5,"organization":{"name":"Test Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} ' headers: @@ -200,7 +200,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '680' + - '691' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -214,7 +214,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -244,17 +244,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/10/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"less + than a minute"}],"org_repository_count":3} ' headers: @@ -263,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1838' + - '2056' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -277,7 +279,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -307,24 +309,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":true,"id":8,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:15 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:25 UTC"}]}]} + minute"}],"type":"rpm","rules":[]}]} ' headers: @@ -333,7 +336,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3072' + - '3137' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,7 +350,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: @@ -377,24 +380,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/8 response: body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":true,"original_packages":false,"id":8,"name":"Test Package + Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:15 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"29b3d88f-d4d9-4411-b1db-69f3a9c7df12","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/00e6944a-841e-4bfe-9416-070861ef58fb/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/7e1e16ba-4432-4a52-988e-3da939154cbe/","publication_href":"/pulp/api/v3/publications/rpm/rpm/9695e87f-67d7-4765-9f98-e9a13987baef/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":18,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[{"content_view_filter_id":8,"content_view_filter_name":"Test + Package Content View Filter","content_view_id":10,"content_view_name":"Test + Content View","last_affected_repo":true}],"last_sync":{"id":"0c110a6a-16e1-487f-a587-0ab648d99eda","username":"admin","started_at":"2023-11-15 + 09:54:33 UTC","ended_at":"2023-11-15 09:54:46 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":8,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1700042066424","generic_remote_options":null,"major":null,"minor":null,"product":{"id":10,"cp_id":"347380074197","name":"Test Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:25 UTC"}]} + minute"}],"type":"rpm","rules":[]} ' headers: @@ -403,7 +407,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3079' + - '3145' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -417,7 +421,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: @@ -444,71 +448,22 @@ interactions: - gzip, deflate Connection: - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:25 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive Content-Length: - - '299' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive + - '0' User-Agent: - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 + method: DELETE + uri: https://foreman.example.org/katello/api/content_views/10/filters/8 response: body: - string: ' {"content_view_filter_id":16,"version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:25 UTC"} + string: ' {"inclusion":true,"original_packages":false,"id":8,"name":"Test Package + Content View Filter","description":null,"created_at":"2023-11-15 09:55:10 + UTC","updated_at":"2023-11-15 09:55:15 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"rpm","rules":[]} ' headers: @@ -517,7 +472,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '145' + - '1295' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -531,9 +486,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=92 + - timeout=15, max=93 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: diff --git a/tests/test_playbooks/fixtures/content_view_filter-8.yml b/tests/test_playbooks/fixtures/content_view_filter-8.yml index 72af46295..3a6a23a3b 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-8.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-8.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1050' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,14 +184,11 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Errata+id+Content+View+Filter%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} + string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Errata id Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} ' headers: @@ -200,324 +197,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:25 UTC"}]}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '3072' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 - response: - body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:25 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '3079' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:25 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '299' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 - response: - body: - string: ' {"content_view_filter_id":16,"version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:25 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '145' + - '189' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -531,9 +211,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=92 + - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -550,7 +230,8 @@ interactions: code: 200 message: OK - request: - body: '{"max_version": "1"}' + body: '{"name": "Test Errata id Content View Filter", "type": "erratum", "inclusion": + false, "repository_ids": []}' headers: Accept: - application/json;version=2 @@ -559,17 +240,22 @@ interactions: Connection: - keep-alive Content-Length: - - '20' + - '107' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) - method: PUT - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 + method: POST + uri: https://foreman.example.org/katello/api/content_views/10/filters response: body: - string: ' {"content_view_filter_id":16,"max_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:28 UTC"} + string: ' {"inclusion":false,"id":9,"name":"Test Errata id Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:16 UTC","updated_at":"2023-11-15 09:55:16 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[]} ' headers: @@ -578,7 +264,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '149' + - '1275' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -592,9 +278,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=91 + - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -608,6 +294,6 @@ interactions: X-XSS-Protection: - 1; mode=block status: - code: 200 - message: OK + code: 201 + message: Created version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_filter-9.yml b/tests/test_playbooks/fixtures/content_view_filter-9.yml index eb5a78b0f..f88172534 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-9.yml +++ b/tests/test_playbooks/fixtures/content_view_filter-9.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 09:54:22 UTC\",\"updated_at\":\"2023-11-15 09:54:23 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -127,10 +127,10 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1049' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -154,7 +154,7 @@ interactions: Foreman_current_organization: - 5; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,147 +184,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/10/filters?search=name%3D%22Test+Errata+id+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":4,"cp_id":"681823227593","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{"success":3},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":"Syncing - Complete.","last_sync":"2023-06-04 21:31:56 UTC","last_sync_words":"1 minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":3}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '680' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - 5; Test Organization - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=97 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/products/4/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 - response: - body: - string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"org_repository_count":3} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '1838' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + Errata id Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":9,"name":"Test + Errata id Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:16 UTC","updated_at":"2023-11-15 09:55:16 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"max_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:28 UTC"}]}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[]}]} ' headers: @@ -333,7 +203,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '3076' + - '1295' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,9 +217,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=95 + - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: @@ -377,81 +247,16 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/16 + uri: https://foreman.example.org/katello/api/content_views/10/filters/9 response: body: - string: ' {"inclusion":false,"original_packages":false,"id":16,"name":"Test - Package Content View Filter","description":null,"created_at":"2023-06-04 21:32:17 - UTC","updated_at":"2023-06-04 21:32:22 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test + string: ' {"inclusion":false,"id":9,"name":"Test Errata id Content View Filter","description":null,"created_at":"2023-11-15 + 09:55:16 UTC","updated_at":"2023-11-15 09:55:16 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[18],"id":10,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[{"backend_identifier":"27e55738-0af2-483d-b82b-d36e31274f45","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://foreman.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/3c3a05c1-0edc-4e02-b86f-2ea62cbe040e/versions/1/","remote_href":"/pulp/api/v3/remotes/rpm/rpm/63d65ab9-0872-4310-b9de-83f33bfa60ba/","publication_href":"/pulp/api/v3/publications/rpm/rpm/aebbb96e-8e0c-483f-b31b-4651771b4723/","content_counts":{"rpm":32,"erratum":4,"package_group":2,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":11,"name":"Test - Repository","label":"Test_Repository","description":null,"content_view_versions":[],"last_sync":{"id":"d710ce99-4c90-42f4-8397-37d098e1fd28","username":"admin","started_at":"2023-06-04 - 21:31:25 UTC","ended_at":"2023-06-04 21:31:34 UTC","state":"stopped","result":"success","progress":1.0},"content_view":{"id":7,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":7},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":"https://repos.fedorapeople.org/pulp/pulp/demo_repos/zoo/","arch":"noarch","os_versions":[],"content_id":"1685914276212","generic_remote_options":null,"major":null,"minor":null,"product":{"id":4,"cp_id":"681823227593","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":"1 - minute"}],"type":"rpm","rules":[{"content_view_filter_id":16,"max_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:28 UTC"}]} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '3083' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules?search=name%3D%22bear%22&per_page=4294967296 - response: - body: - string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[{"content_view_filter_id":16,"max_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:28 UTC"}]} + Organization","label":"Test_Organization","id":5},"created_at":"2023-11-15 + 09:55:08 UTC","updated_at":"2023-11-15 09:55:08 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":18,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":10,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"erratum","rules":[]} ' headers: @@ -460,7 +265,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '303' + - '1275' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -474,66 +279,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - - timeout=15, max=93 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 200 - message: OK -- request: - body: null - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/16/rules/4 - response: - body: - string: ' {"content_view_filter_id":16,"max_version":"1","id":4,"name":"bear","created_at":"2023-06-04 - 21:32:17 UTC","updated_at":"2023-06-04 21:32:28 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive - Content-Length: - - '149' - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 3.7.0-rc2 - Keep-Alive: - - timeout=15, max=92 + - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains X-Content-Type-Options: diff --git a/tests/test_playbooks/fixtures/content_views_role-0.yml b/tests/test_playbooks/fixtures/content_views_role-0.yml index ed592420f..0a4a6880e 100644 --- a/tests/test_playbooks/fixtures/content_views_role-0.yml +++ b/tests/test_playbooks/fixtures/content_views_role-0.yml @@ -14,12 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.4.0","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -33,13 +35,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -50,8 +50,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '62' status: code: 200 message: OK @@ -70,17 +68,18 @@ interactions: uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 response: body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ - : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ - : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ - :\"Test_Organization\",\"created_at\":\"2021-04-23 11:43:51 UTC\",\"updated_at\"\ - :\"2021-04-23 11:43:51 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\"\ - :\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 10:37:36 UTC\",\"updated_at\":\"2023-11-15 10:37:38 UTC\",\"id\":6,\"name\":\"Test + Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '388' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -94,13 +93,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -111,8 +108,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '388' status: code: 200 message: OK @@ -128,10 +123,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + string: '{"total":1,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test Content View\"","sort":{"by":"name","order":"asc"},"results":[]} ' @@ -140,6 +135,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '172' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -151,15 +148,13 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization + - 6; Test Organization Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -170,8 +165,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '157' status: code: 200 message: OK @@ -187,14 +180,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/6/products?search=name%3D%22Test+Product%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":3,"cp_id":"31834253451","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2021-04-23 - 11:43:59 UTC","last_sync_words":"less than a minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":1}]} + string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":11,"cp_id":"505037285537","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":9,"sync_plan_id":null,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2023-11-15 + 10:37:41 UTC","last_sync_words":"less than a minute","organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"sync_plan":null,"repository_count":1}]} ' headers: @@ -202,6 +195,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '665' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -213,15 +208,13 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization + - 6; Test Organization Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -232,8 +225,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '648' status: code: 200 message: OK @@ -249,15 +240,15 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/3/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/11/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"6ba86b50-7879-46be-91f0-0ca39bec7654","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://localhost/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/8948f76b-34fc-4982-8181-1d32d5c90b8d/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/01af8bde-43f9-4ba9-bf92-66303a6f033a/","id":3,"name":"Test - Repository","label":"Test_Repository","description":null,"last_sync":null,"content_view":{"id":9,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":null,"arch":"noarch","os_versions":[],"content_id":"1619178237889","major":null,"minor":null,"product":{"id":3,"cp_id":"31834253451","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","content_counts":{"ostree_branch":0,"docker_manifest":0,"docker_manifest_list":0,"docker_tag":0,"rpm":0,"srpm":0,"package":0,"package_group":0,"erratum":0,"puppet_module":0,"file":0,"deb":0,"module_stream":0,"ansible_collection":0},"last_sync_words":null}]} + string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"09e11185-2b92-425a-b437-018bbd8a82df","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/e202e2e5-779d-4b44-adc4-e554320b0b05/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/8d8c3f21-95de-4bc1-90d9-cc98d88fd471/","content_counts":{"rpm":0,"erratum":0,"package_group":0,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":21,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[],"last_sync":null,"content_view":{"id":11,"name":"Default + Organization View"},"content_view_version":{"id":9,"name":"Default Organization + View 1.0","content_view_id":11},"kt_environment":{"id":5,"name":"Library"},"content_type":"yum","url":null,"arch":"noarch","os_versions":[],"content_id":"1700044660581","generic_remote_options":null,"major":null,"minor":null,"product":{"id":11,"cp_id":"505037285537","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":null}],"org_repository_count":1} ' headers: @@ -265,6 +256,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '1558' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -278,13 +271,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -295,13 +286,11 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '1515' status: code: 200 message: OK - request: - body: '{"name": "Test Content View", "composite": false, "repository_ids": [3], + body: '{"name": "Test Content View", "composite": false, "repository_ids": [21], "auto_publish": false}' headers: Accept: @@ -311,20 +300,20 @@ interactions: Connection: - keep-alive Content-Length: - - '95' + - '96' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/organizations/5/content_views + uri: https://foreman.example.org/katello/api/organizations/6/content_views response: body: - string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":10,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 - 11:44:01 UTC","updated_at":"2021-04-23 11:44:01 UTC","environments":[],"repositories":[{"id":3,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true},"duplicate_repositories_to_publish":[],"errors":null} + string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[21],"id":12,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"created_at":"2023-11-15 + 10:37:43 UTC","updated_at":"2023-11-15 10:37:43 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":21,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"duplicate_repositories_to_publish":[],"errors":null} ' headers: @@ -332,6 +321,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '957' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -343,15 +334,13 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization + - 6; Test Organization Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Transfer-Encoding: - - chunked X-Content-Type-Options: - nosniff X-Download-Options: diff --git a/tests/test_playbooks/fixtures/content_views_role-1.yml b/tests/test_playbooks/fixtures/content_views_role-1.yml index 2e48fa124..6bd8e40dc 100644 --- a/tests/test_playbooks/fixtures/content_views_role-1.yml +++ b/tests/test_playbooks/fixtures/content_views_role-1.yml @@ -14,12 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.4.0","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -33,13 +35,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -50,8 +50,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '62' status: code: 200 message: OK @@ -70,17 +68,18 @@ interactions: uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 response: body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ - : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ - : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ - :\"Test_Organization\",\"created_at\":\"2021-04-23 11:43:51 UTC\",\"updated_at\"\ - :\"2021-04-23 11:43:51 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\"\ - :\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 10:37:36 UTC\",\"updated_at\":\"2023-11-15 10:37:38 UTC\",\"id\":6,\"name\":\"Test + Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '388' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -94,13 +93,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -111,8 +108,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '388' status: code: 200 message: OK @@ -128,10 +123,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":2,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + string: '{"total":2,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[]} ' @@ -140,6 +135,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '182' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -151,15 +148,13 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization + - 6; Test Organization Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -170,8 +165,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '167' status: code: 200 message: OK @@ -192,13 +185,13 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/organizations/5/content_views + uri: https://foreman.example.org/katello/api/organizations/6/content_views response: body: - string: ' {"content_host_count":0,"composite":true,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[],"id":11,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 - 11:44:01 UTC","updated_at":"2021-04-23 11:44:01 UTC","environments":[],"repositories":[],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true},"duplicate_repositories_to_publish":[],"errors":null} + string: ' {"content_host_count":0,"composite":true,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[],"id":13,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"created_at":"2023-11-15 + 10:37:43 UTC","updated_at":"2023-11-15 10:37:43 UTC","last_task":null,"latest_version_environments":[],"repositories":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"duplicate_repositories_to_publish":[],"errors":null} ' headers: @@ -206,6 +199,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '893' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -217,15 +212,13 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization + - 6; Test Organization Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Transfer-Encoding: - - chunked X-Content-Type-Options: - nosniff X-Download-Options: @@ -251,15 +244,15 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":10,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 - 11:44:01 UTC","updated_at":"2021-04-23 11:44:01 UTC","environments":[],"repositories":[{"id":3,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true}}]} + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[21],"id":12,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"created_at":"2023-11-15 + 10:37:43 UTC","updated_at":"2023-11-15 10:37:43 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":21,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -267,6 +260,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '1050' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -278,15 +273,13 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization + - 6; Test Organization Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -297,8 +290,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '1056' status: code: 200 message: OK @@ -314,14 +305,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/10 + uri: https://foreman.example.org/katello/api/content_views/12 response: body: - string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":10,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 - 11:44:01 UTC","updated_at":"2021-04-23 11:44:01 UTC","environments":[],"repositories":[{"id":3,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true},"duplicate_repositories_to_publish":[],"errors":null} + string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[21],"id":12,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"created_at":"2023-11-15 + 10:37:43 UTC","updated_at":"2023-11-15 10:37:43 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":21,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"duplicate_repositories_to_publish":[],"errors":null} ' headers: @@ -329,6 +320,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '957' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -342,13 +335,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -359,13 +350,11 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '978' status: code: 200 message: OK - request: - body: '{"components": [{"latest": true, "content_view_id": 10}]}' + body: '{"components": [{"latest": true, "content_view_id": 12}]}' headers: Accept: - application/json;version=2 @@ -380,13 +369,13 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: PUT - uri: https://foreman.example.org/katello/api/content_views/11/content_view_components/add + uri: https://foreman.example.org/katello/api/content_views/13/content_view_components/add response: body: - string: '{"total":1,"subtotal":1,"page":null,"per_page":null,"error":null,"search":null,"sort":{"by":null,"order":null},"results":[{"latest":true,"id":3,"created_at":"2021-04-23 - 11:44:01 UTC","updated_at":"2021-04-23 11:44:01 UTC","composite_content_view":{"id":11,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":10,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view_version":null}]} + string: '{"total":1,"subtotal":1,"selectable":1,"page":null,"per_page":null,"error":null,"search":null,"sort":{"by":null,"order":null},"results":[{"latest":true,"id":1,"created_at":"2023-11-15 + 10:37:43 UTC","updated_at":"2023-11-15 10:37:43 UTC","composite_content_view":{"id":13,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":12,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view_version":null,"component_content_view_versions":[]}]} ' headers: @@ -394,6 +383,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '647' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -407,13 +398,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=94 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -424,8 +413,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '595' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_views_role-2.yml b/tests/test_playbooks/fixtures/content_views_role-2.yml index 666aea598..84f1e2401 100644 --- a/tests/test_playbooks/fixtures/content_views_role-2.yml +++ b/tests/test_playbooks/fixtures/content_views_role-2.yml @@ -14,12 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.4.0","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -33,13 +35,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -50,8 +50,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '62' status: code: 200 message: OK @@ -70,17 +68,18 @@ interactions: uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 response: body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ - : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ - : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ - :\"Test_Organization\",\"created_at\":\"2021-04-23 11:43:51 UTC\",\"updated_at\"\ - :\"2021-04-23 11:43:51 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\"\ - :\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 10:37:36 UTC\",\"updated_at\":\"2023-11-15 10:37:38 UTC\",\"id\":6,\"name\":\"Test + Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '388' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -94,13 +93,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -111,8 +108,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '388' status: code: 200 message: OK @@ -128,10 +123,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + string: '{"total":3,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test Content View with Filter\"","sort":{"by":"name","order":"asc"},"results":[]} ' @@ -140,6 +135,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '184' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -151,15 +148,13 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization + - 6; Test Organization Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -170,8 +165,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '169' status: code: 200 message: OK @@ -187,14 +180,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/6/products?search=name%3D%22Test+Product%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":3,"cp_id":"31834253451","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2021-04-23 - 11:43:59 UTC","last_sync_words":"less than a minute","organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":1}]} + string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":11,"cp_id":"505037285537","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":9,"sync_plan_id":null,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2023-11-15 + 10:37:41 UTC","last_sync_words":"less than a minute","organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"sync_plan":null,"repository_count":1}]} ' headers: @@ -202,6 +195,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '665' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -213,15 +208,13 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization + - 6; Test Organization Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -232,8 +225,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '648' status: code: 200 message: OK @@ -249,15 +240,15 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/3/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/11/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"6ba86b50-7879-46be-91f0-0ca39bec7654","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://localhost/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/8948f76b-34fc-4982-8181-1d32d5c90b8d/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/01af8bde-43f9-4ba9-bf92-66303a6f033a/","id":3,"name":"Test - Repository","label":"Test_Repository","description":null,"last_sync":null,"content_view":{"id":9,"name":"Default - Organization View"},"content_view_version":{"id":4,"name":"Default Organization - View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":null,"arch":"noarch","os_versions":[],"content_id":"1619178237889","major":null,"minor":null,"product":{"id":3,"cp_id":"31834253451","name":"Test - Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","content_counts":{"ostree_branch":0,"docker_manifest":0,"docker_manifest_list":0,"docker_tag":0,"rpm":0,"srpm":0,"package":0,"package_group":0,"erratum":0,"puppet_module":0,"file":0,"deb":0,"module_stream":0,"ansible_collection":0},"last_sync_words":null}]} + string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"09e11185-2b92-425a-b437-018bbd8a82df","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://centos8-stream-katello-4-9.tanso.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/e202e2e5-779d-4b44-adc4-e554320b0b05/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/8d8c3f21-95de-4bc1-90d9-cc98d88fd471/","content_counts":{"rpm":0,"erratum":0,"package_group":0,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":21,"name":"Test + Repository","label":"Test_Repository","description":null,"content_view_versions":[],"filters":[],"last_sync":null,"content_view":{"id":11,"name":"Default + Organization View"},"content_view_version":{"id":9,"name":"Default Organization + View 1.0","content_view_id":11},"kt_environment":{"id":5,"name":"Library"},"content_type":"yum","url":null,"arch":"noarch","os_versions":[],"content_id":"1700044660581","generic_remote_options":null,"major":null,"minor":null,"product":{"id":11,"cp_id":"505037285537","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","last_sync_words":null}],"org_repository_count":1} ' headers: @@ -265,6 +256,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '1558' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -278,13 +271,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -295,14 +286,12 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '1515' status: code: 200 message: OK - request: body: '{"name": "Test Content View with Filter", "composite": false, "repository_ids": - [3], "auto_publish": false}' + [21], "auto_publish": false}' headers: Accept: - application/json;version=2 @@ -311,20 +300,20 @@ interactions: Connection: - keep-alive Content-Length: - - '107' + - '108' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/organizations/5/content_views + uri: https://foreman.example.org/katello/api/organizations/6/content_views response: body: - string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":12,"name":"Test - Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 - 11:44:02 UTC","updated_at":"2021-04-23 11:44:02 UTC","environments":[],"repositories":[{"id":3,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true},"duplicate_repositories_to_publish":[],"errors":null} + string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[21],"id":14,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"created_at":"2023-11-15 + 10:37:44 UTC","updated_at":"2023-11-15 10:37:44 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":21,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"duplicate_repositories_to_publish":[],"errors":null} ' headers: @@ -332,6 +321,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '981' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -343,15 +334,13 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization + - 6; Test Organization Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=95 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Transfer-Encoding: - - chunked X-Content-Type-Options: - nosniff X-Download-Options: diff --git a/tests/test_playbooks/fixtures/content_views_role-3.yml b/tests/test_playbooks/fixtures/content_views_role-3.yml index 4bf113e60..c5b55313e 100644 --- a/tests/test_playbooks/fixtures/content_views_role-3.yml +++ b/tests/test_playbooks/fixtures/content_views_role-3.yml @@ -14,12 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.4.0","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -33,13 +35,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -50,8 +50,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '62' status: code: 200 message: OK @@ -70,17 +68,18 @@ interactions: uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 response: body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ - : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ - : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ - :\"Test_Organization\",\"created_at\":\"2021-04-23 11:43:51 UTC\",\"updated_at\"\ - :\"2021-04-23 11:43:51 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\"\ - :\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 10:37:36 UTC\",\"updated_at\":\"2023-11-15 10:37:38 UTC\",\"id\":6,\"name\":\"Test + Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '388' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -94,13 +93,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -111,8 +108,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '388' status: code: 200 message: OK @@ -128,15 +123,15 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 response: body: - string: '{"total":4,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View with Filter\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":12,"name":"Test - Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 - 11:44:02 UTC","updated_at":"2021-04-23 11:44:02 UTC","environments":[],"repositories":[{"id":3,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true}}]} + string: '{"total":4,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Content View with Filter\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":false,"repository_ids":[21],"id":14,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"created_at":"2023-11-15 + 10:37:44 UTC","updated_at":"2023-11-15 10:37:44 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":21,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -144,6 +139,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '1086' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -155,15 +152,13 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization + - 6; Test Organization Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -174,8 +169,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '1092' status: code: 200 message: OK @@ -191,10 +184,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/12/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/14/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 response: body: - string: '{"total":0,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} ' @@ -203,6 +196,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive + Content-Length: + - '187' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -216,13 +211,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -233,8 +226,6 @@ interactions: - none X-XSS-Protection: - 1; mode=block - content-length: - - '172' status: code: 200 message: OK @@ -255,17 +246,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/content_views/12/filters + uri: https://foreman.example.org/katello/api/content_views/14/filters response: body: - string: ' {"inclusion":false,"original_packages":false,"id":2,"name":"Test - Package Content View Filter","description":null,"created_at":"2021-04-23 11:44:03 - UTC","updated_at":"2021-04-23 11:44:03 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":12,"name":"Test - Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 - 11:44:02 UTC","updated_at":"2021-04-23 11:44:02 UTC","environments":[],"repositories":[{"id":3,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":3,"name":"Test - Product"},"content_counts":{"ostree_branch":0,"docker_manifest":0,"docker_tag":0,"rpm":0,"package":0,"package_group":0,"erratum":0,"puppet_module":0,"module_stream":0}}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true}},"repositories":[],"type":"rpm","rules":[]} + string: ' {"inclusion":false,"original_packages":false,"id":15,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 10:37:45 + UTC","updated_at":"2023-11-15 10:37:45 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[21],"id":14,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"created_at":"2023-11-15 + 10:37:44 UTC","updated_at":"2023-11-15 10:37:44 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":21,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":11,"name":"Test + Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":0,"package":0,"package_group":0,"erratum":0,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"rpm","rules":[]} ' headers: @@ -273,67 +264,8 @@ interactions: - max-age=0, private, must-revalidate Connection: - Keep-Alive - Content-Security-Policy: - - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; - style-src ''unsafe-inline'' ''self''' - Content-Type: - - application/json; charset=utf-8 - Foreman_api_version: - - '2' - Foreman_current_location: - - ; ANY - Foreman_current_organization: - - ; ANY - Foreman_version: - - 2.4.0 - Keep-Alive: - - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains - Transfer-Encoding: - - chunked - X-Content-Type-Options: - - nosniff - X-Download-Options: - - noopen - X-Frame-Options: - - sameorigin - X-Permitted-Cross-Domain-Policies: - - none - X-XSS-Protection: - - 1; mode=block - status: - code: 201 - message: Created -- request: - body: '{"name": "bear"}' - headers: - Accept: - - application/json;version=2 - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive Content-Length: - - '16' - Content-Type: - - application/json - User-Agent: - - apypie (https://github.com/Apipie/apypie) - method: POST - uri: https://foreman.example.org/katello/api/content_view_filters/2/rules - response: - body: - string: ' {"content_view_filter_id":2,"id":2,"name":"bear","created_at":"2021-04-23 - 11:44:03 UTC","updated_at":"2021-04-23 11:44:03 UTC"} - - ' - headers: - Cache-Control: - - max-age=0, private, must-revalidate - Connection: - - Keep-Alive + - '1318' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -347,13 +279,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.4.0 + - 3.7.1 Keep-Alive: - - timeout=15, max=95 + - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Transfer-Encoding: - - chunked X-Content-Type-Options: - nosniff X-Download-Options: diff --git a/tests/test_playbooks/fixtures/content_view_filter-29.yml b/tests/test_playbooks/fixtures/content_views_role-4.yml similarity index 64% rename from tests/test_playbooks/fixtures/content_view_filter-29.yml rename to tests/test_playbooks/fixtures/content_views_role-4.yml index 5aef4d925..c47fef107 100644 --- a/tests/test_playbooks/fixtures/content_view_filter-29.yml +++ b/tests/test_playbooks/fixtures/content_views_role-4.yml @@ -14,14 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.0-rc2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '66' + - '62' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -35,7 +35,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=100 Strict-Transport-Security: @@ -70,8 +70,8 @@ interactions: body: string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-06-04 - 21:31:10 UTC\",\"updated_at\":\"2023-06-04 21:31:12 UTC\",\"id\":5,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2023-11-15 + 10:37:36 UTC\",\"updated_at\":\"2023-11-15 10:37:38 UTC\",\"id\":6,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -93,7 +93,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=99 Strict-Transport-Security: @@ -123,14 +123,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 response: body: - string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test + string: '{"total":4,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Content View with Filter\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[21],"id":14,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"created_at":"2023-11-15 + 10:37:44 UTC","updated_at":"2023-11-15 10:37:44 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":21,"name":"Test Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' @@ -140,7 +140,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1048' + - '1085' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -152,9 +152,9 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 5; Test Organization + - 6; Test Organization Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=98 Strict-Transport-Security: @@ -184,17 +184,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters?search=name%3D%22Test+Content+View+Filter+-+modulemd%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/14/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 response: body: string: '{"total":1,"subtotal":1,"selectable":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Content View Filter - modulemd\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":21,"name":"Test - Content View Filter - modulemd","description":null,"created_at":"2023-06-04 - 21:32:53 UTC","updated_at":"2023-06-04 21:32:53 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]}]} + Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[{"inclusion":false,"id":15,"name":"Test + Package Content View Filter","description":null,"created_at":"2023-11-15 10:37:45 + UTC","updated_at":"2023-11-15 10:37:45 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[21],"id":14,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"created_at":"2023-11-15 + 10:37:44 UTC","updated_at":"2023-11-15 10:37:44 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":21,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"rpm","rules":[]}]} ' headers: @@ -203,7 +203,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1298' + - '1312' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -217,7 +217,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=97 Strict-Transport-Security: @@ -247,17 +247,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/8/filters/21 + uri: https://foreman.example.org/katello/api/content_view_filters/15/rules?search=name%3D%22bear%22&per_page=4294967296 response: body: - string: ' {"inclusion":false,"original_module_streams":false,"id":21,"name":"Test - Content View Filter - modulemd","description":null,"created_at":"2023-06-04 - 21:32:53 UTC","updated_at":"2023-06-04 21:32:53 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"needs_publish":true,"filtered":true,"repository_ids":[11],"id":8,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test - Organization","label":"Test_Organization","id":5},"created_at":"2023-06-04 - 21:32:14 UTC","updated_at":"2023-06-04 21:32:14 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":11,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","product":{"id":4,"name":"Test - Product"},"content_counts":{"docker_manifest":0,"docker_tag":0,"rpm":32,"package":32,"package_group":2,"erratum":4,"module_stream":0}}],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]},"repositories":[],"type":"modulemd","rules":[]} + string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[]} ' headers: @@ -266,7 +259,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1308' + - '157' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; @@ -280,7 +273,7 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.0-rc2 + - 3.7.1 Keep-Alive: - timeout=15, max=96 Strict-Transport-Security: @@ -298,4 +291,65 @@ interactions: status: code: 200 message: OK +- request: + body: '{"name": "bear"}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '16' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/content_view_filters/15/rules + response: + body: + string: ' {"content_view_filter_id":15,"id":18,"name":"bear","created_at":"2023-11-15 + 10:37:46 UTC","updated_at":"2023-11-15 10:37:46 UTC"} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '132' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.7.1 + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created version: 1 diff --git a/tests/test_playbooks/tasks/content_view_filter_deb.yml b/tests/test_playbooks/tasks/content_view_filter_deb.yml index 66da53131..07098ab87 100644 --- a/tests/test_playbooks/tasks/content_view_filter_deb.yml +++ b/tests/test_playbooks/tasks/content_view_filter_deb.yml @@ -7,7 +7,6 @@ repositories: - name: "Test Repository" product: "Test Product" - package_name: "bear" filter_state: present content_view_filter: username: "{{ foreman_username }}" @@ -19,11 +18,8 @@ content_view: "{{ content_view_name }}" filter_type: "deb" repositories: "{{ repositories }}" - package_name: "{{ package_name }}" - architecture: "{{ architecture | default(omit) }}" inclusion: "{{ inclusion | default(omit) }}" filter_state: "{{ filter_state }}" - rule_state: "{{ rule_state | default(omit) }}" register: result - assert: fail_msg: "Ensuring content view filter is {{ filter_state }} failed! (expected_change: {{ expected_change | default('unknown') }})" diff --git a/tests/test_playbooks/tasks/content_view_filter_docker.yml b/tests/test_playbooks/tasks/content_view_filter_docker.yml index 97201f0b6..e670c8b39 100644 --- a/tests/test_playbooks/tasks/content_view_filter_docker.yml +++ b/tests/test_playbooks/tasks/content_view_filter_docker.yml @@ -4,7 +4,6 @@ content_view_filter_name: "Test Docker Content View Filter" content_view_name: "Test Content View" organization_name: "Test Organization" - tag: "birds" filter_state: present content_view_filter: username: "{{ foreman_username }}" @@ -16,10 +15,8 @@ content_view: "{{ content_view_name }}" filter_type: "docker" repositories: "{{ repositories | default(omit) }}" - tag: "{{ tag }}" inclusion: "{{ inclusion | default(omit) }}" filter_state: "{{ filter_state }}" - rule_state: "{{ rule_state | default(omit) }}" register: result - assert: fail_msg: "Ensuring content view filter is {{ filter_state }} failed! (expected_change: {{ expected_change | default('unknown') }})" diff --git a/tests/test_playbooks/tasks/content_view_filter_errata_date.yml b/tests/test_playbooks/tasks/content_view_filter_errata_date.yml index 524b283ad..335bc82f3 100644 --- a/tests/test_playbooks/tasks/content_view_filter_errata_date.yml +++ b/tests/test_playbooks/tasks/content_view_filter_errata_date.yml @@ -7,8 +7,6 @@ repositories: - name: "Test Repository" product: "Test Product" - end_date: "2018-01-03" - start_date: "2017-01-03" filter_state: present content_view_filter: username: "{{ foreman_username }}" @@ -20,13 +18,8 @@ content_view: "{{ content_view_name }}" filter_type: "erratum" repositories: "{{ repositories }}" - end_date: "{{ end_date }}" - start_date: "{{ start_date }}" - types: "{{ types | default(omit) }}" - date_type: "{{ date_type | default(omit) }}" inclusion: "{{ inclusion | default(omit) }}" filter_state: "{{ filter_state }}" - rule_state: "{{ rule_state | default(omit) }}" register: result - assert: fail_msg: "Ensuring content view filter is {{ filter_state }} failed! (expected_change: {{ expected_change | default('unknown') }})" diff --git a/tests/test_playbooks/tasks/content_view_filter_errata_id.yml b/tests/test_playbooks/tasks/content_view_filter_errata_id.yml index c4631f4ff..3c6f13996 100644 --- a/tests/test_playbooks/tasks/content_view_filter_errata_id.yml +++ b/tests/test_playbooks/tasks/content_view_filter_errata_id.yml @@ -4,7 +4,6 @@ content_view_filter_name: "Test Errata id Content View Filter" content_view_name: "Test Content View" organization_name: "Test Organization" - errata_id: RHEA-2012:0003 filter_state: present content_view_filter: username: "{{ foreman_username }}" @@ -16,10 +15,8 @@ content_view: "{{ content_view_name }}" filter_type: "erratum" repositories: "{{ repositories | default(omit) }}" - errata_id: "{{ errata_id }}" inclusion: "{{ inclusion | default(omit) }}" filter_state: "{{ filter_state }}" - rule_state: "{{ rule_state | default(omit) }}" register: result - assert: fail_msg: "Ensuring content view filter is {{ filter_state }} failed! (expected_change: {{ expected_change | default('unknown') }})" diff --git a/tests/test_playbooks/tasks/content_view_filter_package.yml b/tests/test_playbooks/tasks/content_view_filter_package.yml index 4fda2972d..119d16a27 100644 --- a/tests/test_playbooks/tasks/content_view_filter_package.yml +++ b/tests/test_playbooks/tasks/content_view_filter_package.yml @@ -7,7 +7,6 @@ repositories: - name: "Test Repository" product: "Test Product" - package_name: "bear" filter_state: present content_view_filter: username: "{{ foreman_username }}" @@ -19,15 +18,9 @@ content_view: "{{ content_view_name }}" filter_type: "rpm" repositories: "{{ repositories }}" - package_name: "{{ package_name }}" - version: "{{ version | default(omit) }}" - architecture: "{{ architecture | default(omit) }}" - min_version: "{{ min_version | default(omit) }}" - max_version: "{{ max_version | default(omit) }}" inclusion: "{{ inclusion | default(omit) }}" original_packages: "{{ original_packages | default(omit) }}" filter_state: "{{ filter_state }}" - rule_state: "{{ rule_state | default(omit) }}" register: result - assert: fail_msg: "Ensuring content view filter is {{ filter_state }} failed! (expected_change: {{ expected_change | default('unknown') }})" diff --git a/tests/test_playbooks/tasks/content_view_filter_package_group.yml b/tests/test_playbooks/tasks/content_view_filter_package_group.yml index 430ea618b..7e74baaf6 100644 --- a/tests/test_playbooks/tasks/content_view_filter_package_group.yml +++ b/tests/test_playbooks/tasks/content_view_filter_package_group.yml @@ -4,7 +4,6 @@ content_view_filter_name: "Test Package Group Content View Filter" content_view_name: "Test Content View" organization_name: "Test Organization" - package_group: "birds" filter_state: present content_view_filter: username: "{{ foreman_username }}" @@ -16,10 +15,8 @@ content_view: "{{ content_view_name }}" filter_type: "package_group" repositories: "{{ repositories | default(omit) }}" - package_group: "{{ package_group }}" inclusion: "{{ inclusion | default(omit) }}" filter_state: "{{ filter_state }}" - rule_state: "{{ rule_state | default(omit) }}" register: result - assert: fail_msg: "Ensuring content view filter is {{ filter_state }} failed! (expected_change: {{ expected_change | default('unknown') }})" From 2864f87f96fe4d347c93287c88374ba60c17453d Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Thu, 16 Nov 2023 14:48:55 +0100 Subject: [PATCH 02/19] do not set the default url for the inventory to localhost:3000 Co-authored-by: Griffin Sullivan <48397354+Griffin-Sullivan@users.noreply.github.com> --- changelogs/fragments/inventory-no-default-localhost.yml | 2 ++ plugins/inventory/foreman.py | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 changelogs/fragments/inventory-no-default-localhost.yml diff --git a/changelogs/fragments/inventory-no-default-localhost.yml b/changelogs/fragments/inventory-no-default-localhost.yml new file mode 100644 index 000000000..528aff2f7 --- /dev/null +++ b/changelogs/fragments/inventory-no-default-localhost.yml @@ -0,0 +1,2 @@ +breaking_changes: + - inventory plugin - do not default to ``http://localhost:3000`` as the Foreman URL, providing a URL is now mandatory diff --git a/plugins/inventory/foreman.py b/plugins/inventory/foreman.py index 1c165196b..076bf2171 100644 --- a/plugins/inventory/foreman.py +++ b/plugins/inventory/foreman.py @@ -32,7 +32,7 @@ url: description: - URL of the Foreman server. - default: 'http://localhost:3000' + required: true env: - name: FOREMAN_SERVER - name: FOREMAN_SERVER_URL From c73cba9c0d9eacc8b1e59ef1f9bce1e560bb5a2b Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Mon, 27 Nov 2023 10:10:06 +0100 Subject: [PATCH 03/19] fix typo in content credentials task name --- roles/content_credentials/tasks/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/content_credentials/tasks/main.yml b/roles/content_credentials/tasks/main.yml index d4d7ba435..0eec9d75b 100644 --- a/roles/content_credentials/tasks/main.yml +++ b/roles/content_credentials/tasks/main.yml @@ -1,5 +1,5 @@ --- -- name: 'Create Content Crendentials' +- name: 'Create Content Credentials' theforeman.foreman.content_credential: username: "{{ foreman_username | default(omit) }}" password: "{{ foreman_password | default(omit) }}" From b203ce35f540321b64449279e5a3c565b0b871b1 Mon Sep 17 00:00:00 2001 From: Lukas Kallies Date: Thu, 7 Dec 2023 14:50:21 +0100 Subject: [PATCH 04/19] Fix indentation of with_fileglob in examples --- plugins/modules/job_template.py | 26 ++++++++++++------------ plugins/modules/partition_table.py | 4 ++-- plugins/modules/provisioning_template.py | 4 ++-- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/plugins/modules/job_template.py b/plugins/modules/job_template.py index df2fe732f..57ed1577e 100644 --- a/plugins/modules/job_template.py +++ b/plugins/modules/job_template.py @@ -176,9 +176,9 @@ - name: toDelete input_type: user locations: - - Gallifrey + - Gallifrey organizations: - - TARDIS INC + - TARDIS INC - name: "Create a Job Template from a file" theforeman.foreman.job_template: @@ -192,9 +192,9 @@ input_type: user state: present locations: - - Gallifrey + - Gallifrey organizations: - - TARDIS INC + - TARDIS INC - name: "remove a job template's template inputs" theforeman.foreman.job_template: @@ -205,9 +205,9 @@ template_inputs: [] state: present locations: - - Gallifrey + - Gallifrey organizations: - - TARDIS INC + - TARDIS INC - name: "Delete a Job Template" theforeman.foreman.job_template: @@ -226,9 +226,9 @@ name: Wibbly Wobbly Template state: present locations: - - Gallifrey + - Gallifrey organizations: - - TARDIS INC + - TARDIS INC # Providing a name in this case wouldn't be very sensible. # Alternatively make use of with_filetree to parse recursively with filter. @@ -240,9 +240,9 @@ file_name: "{{ item }}" state: present locations: - - SKARO + - SKARO organizations: - - DALEK INC + - DALEK INC with_fileglob: - "./arsenal_templates/*.erb" @@ -276,9 +276,9 @@ name: "*" state: present organizations: - - DALEK INC - - sky.net - - Doc Brown's garage + - DALEK INC + - sky.net + - Doc Brown's garage ''' diff --git a/plugins/modules/partition_table.py b/plugins/modules/partition_table.py index 1ddccea76..669a74dd1 100644 --- a/plugins/modules/partition_table.py +++ b/plugins/modules/partition_table.py @@ -140,8 +140,8 @@ - SKARO organizations: - DALEK INC - with_fileglob: - - "./arsenal_templates/*.erb" + with_fileglob: + - "./arsenal_templates/*.erb" # If the templates are stored locally and the ansible module is executed on a remote host - name: Ensure latest version of all Ptable Community Templates diff --git a/plugins/modules/provisioning_template.py b/plugins/modules/provisioning_template.py index 0a52f8dec..e47da4d6a 100644 --- a/plugins/modules/provisioning_template.py +++ b/plugins/modules/provisioning_template.py @@ -167,8 +167,8 @@ - SKARO organizations: - DALEK INC - with_fileglob: - - "./arsenal_templates/*.erb" + with_fileglob: + - "./arsenal_templates/*.erb" # If the templates are stored locally and the ansible module is executed on a remote host - name: Ensure latest version of all Provisioning Community Templates From ce80aefc8622abca859871f632a13d4aae2ed05a Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Thu, 7 Dec 2023 20:46:28 -0500 Subject: [PATCH 05/19] do not use jinja in assert, we can use filters directly --- tests/test_playbooks/content_view_filter_rule_info.yml | 2 +- tests/test_playbooks/filters.yml | 8 ++++---- tests/test_playbooks/host_info.yml | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/tests/test_playbooks/content_view_filter_rule_info.yml b/tests/test_playbooks/content_view_filter_rule_info.yml index b956a43c8..00e91bd0e 100644 --- a/tests/test_playbooks/content_view_filter_rule_info.yml +++ b/tests/test_playbooks/content_view_filter_rule_info.yml @@ -267,7 +267,7 @@ ansible.builtin.assert: fail_msg: "Ensuring content view filter info is valid failed!" that: - - "{{ result['content_view_filter_rules']|length }} != 0" + - result['content_view_filter_rules']|length != 0 - name: "Fetch content_view_filter_info - deb exlude" diff --git a/tests/test_playbooks/filters.yml b/tests/test_playbooks/filters.yml index 70c67f21e..614f9fa7e 100644 --- a/tests/test_playbooks/filters.yml +++ b/tests/test_playbooks/filters.yml @@ -10,8 +10,8 @@ msg: "{{ 'Test__String)' | theforeman.foreman.cp_label }}" - assert: that: - - "{{ 'Test String' | theforeman.foreman.cp_label == 'Test_String' }}" - - "{{ 'Test__String' | theforeman.foreman.cp_label == 'Test__String' }}" - - "{{ 'Test--String' | theforeman.foreman.cp_label == 'Test--String' }}" - - "{{ 'Test (String) 1234' | theforeman.foreman.cp_label == 'Test_String_1234' }}" + - "'Test String' | theforeman.foreman.cp_label == 'Test_String'" + - "'Test__String' | theforeman.foreman.cp_label == 'Test__String'" + - "'Test--String' | theforeman.foreman.cp_label == 'Test--String'" + - "'Test (String) 1234' | theforeman.foreman.cp_label == 'Test_String_1234'" ... diff --git a/tests/test_playbooks/host_info.yml b/tests/test_playbooks/host_info.yml index 78b0eb4ab..5dc3b83d2 100644 --- a/tests/test_playbooks/host_info.yml +++ b/tests/test_playbooks/host_info.yml @@ -54,7 +54,7 @@ - name: check host details assert: that: - - host_info['host']['name'] == "test-host.{{ host.domain }}" + - host_info['host']['name'] == "test-host.{}".format(host.domain) - host_info['host']['domain_name'] == host.domain - name: search host info @@ -70,7 +70,7 @@ - name: check host details assert: that: - - host_info['hosts'][0]['name'] == "test-host.{{ host.domain }}" + - host_info['hosts'][0]['name'] == "test-host.{}".format(host.domain) - host_info['hosts'][0]['domain_name'] == host.domain - hosts: localhost From 1a372fd71e49668e22be1c369a24209faa02cf36 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Fri, 8 Dec 2023 11:46:07 +0000 Subject: [PATCH 06/19] fix jinja expressions in inventory tests --- tests/test_playbooks/inventory_plugin.yml | 2 ++ .../inventory_plugin_ansible.yml | 2 ++ .../tasks/inventory_plugin_tests.yml | 22 +++++++++---------- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/tests/test_playbooks/inventory_plugin.yml b/tests/test_playbooks/inventory_plugin.yml index 9305b22ec..f1dd29296 100644 --- a/tests/test_playbooks/inventory_plugin.yml +++ b/tests/test_playbooks/inventory_plugin.yml @@ -3,7 +3,9 @@ vars: foreman_groups: - name: group_a + label: group_a - name: group_b + label: group_b - name: group_c label: group_b/group_c parent: group_b diff --git a/tests/test_playbooks/inventory_plugin_ansible.yml b/tests/test_playbooks/inventory_plugin_ansible.yml index 5e5e7c4bd..ae6c31dd9 100644 --- a/tests/test_playbooks/inventory_plugin_ansible.yml +++ b/tests/test_playbooks/inventory_plugin_ansible.yml @@ -3,7 +3,9 @@ vars: foreman_groups: - name: group_a + label: group_a - name: group_b + label: group_b - name: group_c label: group_b/group_c parent: group_b diff --git a/tests/test_playbooks/tasks/inventory_plugin_tests.yml b/tests/test_playbooks/tasks/inventory_plugin_tests.yml index ad2e522c9..383893575 100644 --- a/tests/test_playbooks/tasks/inventory_plugin_tests.yml +++ b/tests/test_playbooks/tasks/inventory_plugin_tests.yml @@ -1,47 +1,47 @@ --- - name: test that all groups are present assert: - that: > - 'foreman_{{ item.label | default(item.name) | regex_replace('/', '_') }}' in groups + that: + - "'foreman_{}'.format(item.label.replace('/', '_')) in groups" with_items: "{{ foreman_groups }}" - name: test that all hosts are in the "all" group assert: - that: > - '{{ item.key }}' in groups['all'] + that: + - "item.key in groups['all']" with_dict: "{{ foreman_hosts }}" - name: test that all hosts are in the correct hostgroup assert: - that: > - '{{ item.key }}' in groups['foreman_{{ item.value | regex_replace('/', '_') }}'] + that: + - "item.key in groups['foreman_{}'.format(item.value.replace('/', '_'))]" with_dict: "{{ foreman_hosts }}" - name: dump all host details debug: - var: "hostvars['{{ item.key }}']" + var: "hostvars[item.key]" with_dict: "{{ foreman_hosts }}" - name: test that all hosts have the domain fact set assert: that: > - hostvars['{{ item.key }}']['foreman_facts']['domain'] == 'example.com' + hostvars[item.key]['foreman_facts']['domain'] == 'example.com' with_dict: "{{ foreman_hosts }}" - name: test that all hosts have the OS fact set assert: that: > - hostvars['{{ item.key }}']['foreman_facts']['operatingsystem'] == 'CentOS' + hostvars[item.key]['foreman_facts']['operatingsystem'] == 'CentOS' with_dict: "{{ foreman_hosts }}" - name: test that all hosts have the testparam1 assert: that: > - hostvars['{{ item.key }}']['testparam1'] == 'testvalue1' + hostvars[item.key]['testparam1'] == 'testvalue1' with_dict: "{{ foreman_hosts }}" - name: test that all hosts have the testparam2 assert: that: > - hostvars['{{ item.key }}']['testparam2'] == 'testvalue2' + hostvars[item.key]['testparam2'] == 'testvalue2' with_dict: "{{ foreman_hosts }}" From de3d214446ea34b4f79a1be76f04a2d088ce781d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 8 Dec 2023 12:05:10 +0000 Subject: [PATCH 07/19] Bump actions/setup-python from 4 to 5 Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/v4...v5) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/docs.yml | 2 +- .github/workflows/main.yml | 12 ++++++------ .github/workflows/release.yml | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 8e15720d1..f24936ac3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -23,7 +23,7 @@ jobs: git config user.email "${GITHUB_ACTOR}@bots.github.com" git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/* - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: "3.11" - name: Install dependencies diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 9dbdb3212..7599a4705 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -50,7 +50,7 @@ jobs: steps: - uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python }} cache: 'pip' @@ -95,7 +95,7 @@ jobs: steps: - uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: "3.11" cache: 'pip' @@ -122,7 +122,7 @@ jobs: steps: - uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: "3.11" cache: 'pip' @@ -144,7 +144,7 @@ jobs: steps: - uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: "3.11" cache: 'pip' @@ -159,7 +159,7 @@ jobs: steps: - uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: "3.11" cache: 'pip' @@ -181,7 +181,7 @@ jobs: steps: - uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: "3.11" cache: 'pip' diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 217877b5e..328156994 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -16,7 +16,7 @@ jobs: steps: - uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: "3.11" - name: Install Ansible From 4e8b740cdbf8e7499befcfe96cc03de2ce61f523 Mon Sep 17 00:00:00 2001 From: Jan Jansky Date: Thu, 8 Jun 2023 15:04:56 +0200 Subject: [PATCH 08/19] Plugin content_view_version timeout increase In specific content views which are using filters publish or promote may exceed task_timeout. Proposing update from 60 * 60 to 180 * 60. Signed-off-by: Jan Jansky --- plugins/modules/content_view_version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/modules/content_view_version.py b/plugins/modules/content_view_version.py index 42567483e..f9ba6414c 100644 --- a/plugins/modules/content_view_version.py +++ b/plugins/modules/content_view_version.py @@ -200,7 +200,7 @@ def main(): mutually_exclusive=[['current_lifecycle_environment', 'version']], ) - module.task_timeout = 60 * 60 + module.task_timeout = 180 * 60 if 'version' in module.foreman_params and not re.match(r'^\d+\.\d+$', module.foreman_params['version']): try: From a69d83fb8681ca80878d8143d27594eb72ee295d Mon Sep 17 00:00:00 2001 From: Francesco Trentini Date: Tue, 28 Nov 2023 11:34:18 +0100 Subject: [PATCH 09/19] change storage_pod['id'] to storage_pod['name'] --- changelogs/fragments/1247-reference_storage_pod_name.yml | 2 ++ plugins/modules/compute_profile.py | 2 +- plugins/modules/host.py | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) create mode 100644 changelogs/fragments/1247-reference_storage_pod_name.yml diff --git a/changelogs/fragments/1247-reference_storage_pod_name.yml b/changelogs/fragments/1247-reference_storage_pod_name.yml new file mode 100644 index 000000000..27e1fd6a5 --- /dev/null +++ b/changelogs/fragments/1247-reference_storage_pod_name.yml @@ -0,0 +1,2 @@ +bugfixes: + - compute_profile, host - refer to VMware storage pods by name, not id (https://github.com/theforeman/foreman-ansible-modules/issues/1247) diff --git a/plugins/modules/compute_profile.py b/plugins/modules/compute_profile.py index dc2f3667f..5f87fdf22 100644 --- a/plugins/modules/compute_profile.py +++ b/plugins/modules/compute_profile.py @@ -208,7 +208,7 @@ def main(): for volume in ca_module_params['vm_attrs']['volumes_attributes'].values(): if 'storage_pod' in volume: storage_pod = module.find_storage_pod(volume['storage_pod'], compute_resource, cluster) - volume['storage_pod'] = storage_pod['id'] + volume['storage_pod'] = storage_pod['name'] if 'storage_domain' in volume: storage_domain = module.find_storage_domain(volume['storage_domain'], compute_resource, cluster) volume['storage_domain'] = storage_domain['id'] diff --git a/plugins/modules/host.py b/plugins/modules/host.py index 6c1f41d07..e0da3bbf3 100644 --- a/plugins/modules/host.py +++ b/plugins/modules/host.py @@ -507,7 +507,7 @@ def main(): for volume in module.foreman_params['compute_attributes']['volumes_attributes'].values(): if 'storage_pod' in volume: storage_pod = module.find_storage_pod(volume['storage_pod'], compute_resource, cluster) - volume['storage_pod'] = storage_pod['id'] + volume['storage_pod'] = storage_pod['name'] if 'storage_domain' in volume: storage_domain = module.find_storage_domain(volume['storage_domain'], compute_resource, cluster) volume['storage_domain'] = storage_domain['id'] From 86f3085c81c05da8b184794149d38a034d126620 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 13 Dec 2023 19:55:49 +0000 Subject: [PATCH 10/19] Bump github/codeql-action from 2 to 3 Bumps [github/codeql-action](https://github.com/github/codeql-action) from 2 to 3. - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/v2...v3) --- updated-dependencies: - dependency-name: github/codeql-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/codeql-analysis.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 1a96cd9f0..3c9224443 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -29,9 +29,9 @@ jobs: uses: actions/checkout@v4 - name: Initialize CodeQL - uses: github/codeql-action/init@v2 + uses: github/codeql-action/init@v3 with: languages: ${{ matrix.language }} - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v2 + uses: github/codeql-action/analyze@v3 From b526b1ac7a68bd763a7fad481c8e1aadc25c27d5 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Thu, 14 Dec 2023 09:05:46 +0100 Subject: [PATCH 11/19] don't set entity_name in product module it can be derived from the class name just fine --- plugins/modules/product.py | 1 - 1 file changed, 1 deletion(-) diff --git a/plugins/modules/product.py b/plugins/modules/product.py index 9a99e0893..f2a2a0d30 100644 --- a/plugins/modules/product.py +++ b/plugins/modules/product.py @@ -120,7 +120,6 @@ class KatelloProductModule(KatelloEntityAnsibleModule): def main(): module = KatelloProductModule( - entity_name='product', foreman_spec=dict( name=dict(required=True), label=dict(), From a9d40205621aca8399f239b741c19790d1d81506 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 14 Dec 2023 19:28:45 +0000 Subject: [PATCH 12/19] Bump actions/upload-artifact from 3 to 4 Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 7599a4705..d96bb8fa1 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -134,7 +134,7 @@ jobs: - name: Build docs run: make doc - name: Upload docs artifact - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: docs-html path: docs/_build/html/ @@ -171,7 +171,7 @@ jobs: - name: Run lint run: make lint - name: Upload collection artifact - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: collection path: theforeman-foreman-*.tar.gz From 0be80a461751c7547cced556454f1ef91d28a459 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Thu, 16 Nov 2023 09:31:31 +0100 Subject: [PATCH 13/19] add registration_command module Fixes: #1284 --- meta/runtime.yml | 1 + plugins/modules/registration_command.py | 205 +++++++++++++++ .../fixtures/apidoc/registration_command.json | 1 + .../fixtures/registration_command-0.yml | 233 ++++++++++++++++++ tests/test_playbooks/registration_command.yml | 39 +++ .../tasks/registration_command.yml | 18 ++ 6 files changed, 497 insertions(+) create mode 100644 plugins/modules/registration_command.py create mode 120000 tests/fixtures/apidoc/registration_command.json create mode 100644 tests/test_playbooks/fixtures/registration_command-0.yml create mode 100644 tests/test_playbooks/registration_command.yml create mode 100644 tests/test_playbooks/tasks/registration_command.yml diff --git a/meta/runtime.yml b/meta/runtime.yml index 9e34e240e..068fce2f6 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -53,6 +53,7 @@ action_groups: - puppet_environment - puppetclasses_import - realm + - registration_command - repository - repository_info - repository_set diff --git a/plugins/modules/registration_command.py b/plugins/modules/registration_command.py new file mode 100644 index 000000000..9262febc1 --- /dev/null +++ b/plugins/modules/registration_command.py @@ -0,0 +1,205 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# (c) Evgeni Golov +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + + +DOCUMENTATION = ''' +--- +module: registration_command +version_added: 4.0.0 +short_description: Manage Registration Command +description: + - Manage Registration Command +author: + - "Evgeni Golov (@evgeni)" +options: + activation_keys: + description: + - Activation keys for subscription-manager client, required for CentOS and Red Hat + Enterprise Linux. + - Required only if host group has no activation keys. + required: false + type: list + elements: str + force: + description: + - "Clear any previous registration and run C(subscription-manager) with C(--force)." + required: false + type: bool + hostgroup: + description: + - Host group to register the host in. + required: false + type: str + ignore_subman_errors: + description: + - Ignore C(subscription-manager) errors for C(subscription-manager register) command. + required: false + type: bool + insecure: + description: + - Enable insecure argument for the initial C(curl). + required: false + type: bool + jwt_expiration: + description: + - Expiration of the authorization token (in hours). + required: false + type: int + lifecycle_environment: + description: + - Lifecycle environment for the host. + required: false + type: str + operatingsystem: + description: + - Operating System to register the host in. + - Operating system must have a C(host_init_config) template assigned. + required: false + type: str + packages: + description: + - Packages to install on the host when registered. + - Multiple packages are to be given as a space delimited string. + required: false + type: str + remote_execution_interface: + description: + - Identifier of the Host interface for Remote execution. + required: false + type: str + repo: + description: + - Repository URL (yum/dnf) or full sources.list entry (apt). + required: false + type: str + repo_gpg_key_url: + description: + - URL of the GPG key for the repository. + required: false + type: str + setup_insights: + description: + - If this is set to C(true), C(insights-client) will be installed + and registered on Red Hat family operating systems. + required: false + type: bool + setup_remote_execution: + description: + - If this is set to true, SSH keys will be installed on the host. + required: false + type: bool + setup_remote_execution_pull: + description: + - If this is set to true, pull provider client will be deployed on the host. + required: false + type: bool + smart_proxy: + description: + - Name of Smart Proxy. + - This Proxy must have both the C(Templates) and C(Registration) features enabled. + required: false + type: str + update_packages: + description: + - Update all packages on the host. + required: false + type: bool + organization: + description: + - Organization to register the host in. + required: false + type: str + location: + description: + - Location to register the host in. + required: false + type: str + +extends_documentation_fragment: + - theforeman.foreman.foreman +''' + +EXAMPLES = ''' +- name: "Generate registration command" + theforeman.foreman.registration_command: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + register: command + +- name: "Perform registration" + ansible.builtin.shell: + cmd: "{{ command.registration_command }}" +''' + +RETURN = ''' +registration_command: + description: The generated registration command. + returned: success + type: str +''' + +from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanAnsibleModule + + +class ForemanRegistrationCommandModule(ForemanAnsibleModule): + pass + + +def main(): + module = ForemanRegistrationCommandModule( + foreman_spec=dict( + hostgroup=dict(type='entity'), + operatingsystem=dict(type='entity'), + smart_proxy=dict(type='entity'), + setup_insights=dict(type='bool'), + setup_remote_execution=dict(type='bool'), + jwt_expiration=dict(type='int'), + insecure=dict(type='bool'), + packages=dict(type='str'), + update_packages=dict(type='bool'), + repo=dict(type='str'), + repo_gpg_key_url=dict(type='str', no_log=False), + remote_execution_interface=dict(type='str'), + setup_remote_execution_pull=dict(type='bool'), + activation_keys=dict(type='list', elements='str', no_log=False), + lifecycle_environment=dict(type='entity'), + force=dict(type='bool'), + ignore_subman_errors=dict(type='bool'), + organization=dict(type='entity'), + location=dict(type='entity'), + ), + required_plugins=[ + ('katello', ['activation_key', 'activation_keys', 'lifecycle_environment', 'ignore_subman_errors', 'force']), + ('remote_execution', ['remote_execution_interface', 'setup_remote_execution_pull']), + ], + ) + + with module.api_connection(): + module.auto_lookup_entities() + if not module.check_mode: + command = module.ensure_entity('registration_commands', module.foreman_params, None, state='present')['registration_command'] + else: + command = "curl | bash" + module.exit_json(registration_command=command) + + +if __name__ == '__main__': + main() diff --git a/tests/fixtures/apidoc/registration_command.json b/tests/fixtures/apidoc/registration_command.json new file mode 120000 index 000000000..f9e401512 --- /dev/null +++ b/tests/fixtures/apidoc/registration_command.json @@ -0,0 +1 @@ +foreman.json \ No newline at end of file diff --git a/tests/test_playbooks/fixtures/registration_command-0.yml b/tests/test_playbooks/fixtures/registration_command-0.yml new file mode 100644 index 000000000..9058bb86d --- /dev/null +++ b/tests/test_playbooks/fixtures/registration_command-0.yml @@ -0,0 +1,233 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"3.9.0-develop","api_version":2}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '70' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2023-11-16 + 08:49:34 UTC\",\"updated_at\":\"2023-11-16 08:49:34 UTC\",\"id\":4,\"name\":\"Test + Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '412' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/locations?search=title%3D%22Test+Location%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"title=\\\"Test Location\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2023-11-16 + 08:49:33 UTC\",\"updated_at\":\"2023-11-16 08:49:33 UTC\",\"id\":3,\"name\":\"Test + Location\",\"title\":\"Test Location\",\"description\":null}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '384' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: '{"location_id": 3, "organization_id": 4, "registration_command": {"organization_id": + 4, "location_id": 3}}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '106' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/api/registration_commands + response: + body: + string: '{"registration_command":"curl -sS ''https://centos8-stream-foreman-nightly.tanso.example.com/register?location_id=3\u0026organization_id=4'' + -H ''Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo0LCJpYXQiOjE3MDAxMjQ1NzUsImp0aSI6ImFkYWI4Yjk3ODM2YjE3MDMyODkzZDFhZjdhZjVmZWU3NWQ5ODc4OWRjNThjMzY1NmRhYTdkMTZkY2Y2ODdjYjAiLCJleHAiOjE3MDAxMzg5NzUsInNjb3BlIjoicmVnaXN0cmF0aW9uI2dsb2JhbCByZWdpc3RyYXRpb24jaG9zdCJ9.Yhj65zPC-9D91P5SdBxKThVsskRyq5sGCAAGdG4fgis'' + | bash"}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '465' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - 3; Test Location + Foreman_current_organization: + - 4; Test Organization + Foreman_version: + - 3.9.0-develop + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/registration_command.yml b/tests/test_playbooks/registration_command.yml new file mode 100644 index 000000000..f16298881 --- /dev/null +++ b/tests/test_playbooks/registration_command.yml @@ -0,0 +1,39 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include_tasks: tasks/location.yml + vars: + location_state: "present" + - include_tasks: tasks/organization.yml + vars: + organization_state: "present" + +- hosts: tests + collections: + - theforeman.foreman + tags: + - test + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include_tasks: tasks/registration_command.yml + +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include_tasks: tasks/location.yml + vars: + location_state: "absent" + - include_tasks: tasks/organization.yml + vars: + organization_state: "absent" diff --git a/tests/test_playbooks/tasks/registration_command.yml b/tests/test_playbooks/tasks/registration_command.yml new file mode 100644 index 000000000..e8bb2a618 --- /dev/null +++ b/tests/test_playbooks/tasks/registration_command.yml @@ -0,0 +1,18 @@ +--- +- name: "Generate Registration Command" + vars: + rc_organization: Test Organization + rc_location: Test Location + registration_command: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + organization: "{{ rc_organization }}" + location: "{{ rc_location }}" + register: result +- assert: + fail_msg: "Ensuring registering command is generated failed!" + that: + - "'curl' in result.registration_command" +... From d2e43f97e7159b38b4579f66dfe390251801cdbd Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Mon, 8 Jan 2024 09:08:03 +0100 Subject: [PATCH 14/19] update luna.json to Foreman 3.9/Katello 4.11 --- tests/fixtures/apidoc/luna.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/fixtures/apidoc/luna.json b/tests/fixtures/apidoc/luna.json index b3ebfd9a3..f0efb9c39 100644 --- a/tests/fixtures/apidoc/luna.json +++ b/tests/fixtures/apidoc/luna.json @@ -1 +1 @@ -{"docs":{"name":"Foreman","info":"\n\u003cp\u003eForeman API v2 is currently the default API version.\u003c/p\u003e\n","copyright":"","doc_url":"../apidoc/v2","api_url":"/api","resources":{"host_subscriptions":{"doc_url":"../apidoc/v2/host_subscriptions","id":"host_subscriptions","api_url":"/api","name":"Host subscriptions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_subscriptions/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"GET","short_description":"List a host's subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"DELETE","short_description":"Unregister the host as a subscription consumer","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/create","name":"create","apis":[{"api_url":"/api/hosts/subscriptions","http_method":"POST","short_description":"Register a host with subscription and information","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003eUUID to use for registered host, random uuid is generated if not provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003eKey-value hash of subscription-manager facts, nesting uses a period\ndelimiter (.)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"hypervisor_guest_uuids","description":"\n\u003cp\u003eUUIDs of the virtual guests from the host\u0026#39;s hypervisor\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products","full_name":"installed_products","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"installed_products[product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"installed_products[product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"installed_products[arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"installed_products[version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003eRelease version of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eA service level for auto-healing process, e.g. SELF-SUPPORT\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"lifecycle_environment_id","description":"\n\u003cp\u003eLifecycle Environment ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent View ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/remove_subscriptions","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eIf specified, remove the first instance of a subscription with matching id\nand quantity\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/add_subscriptions","http_method":"PUT","short_description":"Add a subscription to a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/content_override","name":"content_override","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/content_override","http_method":"PUT","short_description":"Set content overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n\u003cp\u003eOverride to a boolean value or \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be\n\u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/product_content","name":"product_content","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/product_content","http_method":"GET","short_description":"Get content and overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the host\u0026#39;s content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/available_release_versions","name":"available_release_versions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/available_release_versions","http_method":"GET","short_description":"Show releases available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"hosts":{"doc_url":"../apidoc/v2/hosts","id":"hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null},{"api_url":"/api/environments/:environment_id/hosts","http_method":"GET","short_description":"List hosts per environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"thin","full_name":"thin","description":"\n\u003cp\u003eOnly list ID and name of hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eparameters\u003c/code\u003e, \u003ccode\u003eall_parameters\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"activation_key","type":"string"},{"name":"activation_key_id","type":"string"},{"name":"addon","type":"string"},{"name":"addons_status","values":["mismatched","matched","not_specified"]},{"name":"applicable_errata","type":"string"},{"name":"applicable_errata_issued","type":"date"},{"name":"applicable_rpms","type":"string"},{"name":"architecture","type":"string"},{"name":"autoheal","type":"boolean"},{"name":"available_module_stream_name","type":"string"},{"name":"available_module_stream_stream","type":"string"},{"name":"boot_time","type":""},{"name":"build","values":["true","false"]},{"name":"class","type":"string"},{"name":"comment","type":"text"},{"name":"compute_resource","type":"string"},{"name":"compute_resource_id","type":"integer"},{"name":"config_group","type":"string"},{"name":"content_source","type":"string"},{"name":"content_view","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"created_at","type":"datetime"},{"name":"domain","type":"string"},{"name":"domain_id","type":"integer"},{"name":"environment","type":"string"},{"name":"errata_status","values":["security_needed","errata_needed","updated","unknown"]},{"name":"facts","type":"string"},{"name":"global_status","values":["ok","warning","error"]},{"name":"has_ip","type":"string"},{"name":"has_mac","type":"string"},{"name":"host_collection","type":"string"},{"name":"host_collection_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_id","type":"integer"},{"name":"hostgroup_name","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"hypervisor","values":["true","false"]},{"name":"hypervisor_host","type":"string"},{"name":"image","type":"string"},{"name":"installable_errata","type":"string"},{"name":"installed_at","type":"datetime"},{"name":"installed_package","type":"string"},{"name":"installed_package_name","type":"string"},{"name":"ip","type":"string"},{"name":"last_checkin","type":"datetime"},{"name":"last_report","type":"datetime"},{"name":"lifecycle_environment","type":"string"},{"name":"lifecycle_environment_id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mac","type":"string"},{"name":"managed","values":["true","false"]},{"name":"model","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"owner","type":"string"},{"name":"owner_id","type":"integer"},{"name":"owner_type","type":"string"},{"name":"params","type":"string"},{"name":"params_name","type":"string"},{"name":"parent_hostgroup","type":"string"},{"name":"pools_expiring_in_days","type":"string"},{"name":"puppet_ca","type":"string"},{"name":"puppet_proxy_id","type":"integer"},{"name":"puppetmaster","type":"string"},{"name":"purpose_status","values":["mismatched","matched","not_specified"]},{"name":"realm","type":"string"},{"name":"realm_id","type":"integer"},{"name":"registered_at","type":"datetime"},{"name":"registered_through","type":"string"},{"name":"release_version","type":"string"},{"name":"role","type":"text"},{"name":"role_status","values":["mismatched","matched","not_specified"]},{"name":"service_level","type":"string"},{"name":"sla_status","values":["mismatched","matched","not_specified"]},{"name":"smart_proxy","type":"string"},{"name":"status.applied","type":"integer"},{"name":"status.enabled","values":["true","false"]},{"name":"status.failed","type":"integer"},{"name":"status.failed_restarts","type":"integer"},{"name":"status.interesting","values":["true","false"]},{"name":"status.pending","type":"integer"},{"name":"status.restarted","type":"integer"},{"name":"status.skipped","type":"integer"},{"name":"subnet","type":"string"},{"name":"subnet.name","type":"text"},{"name":"subnet6","type":"string"},{"name":"subnet6.name","type":"text"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"subscription_status","values":["valid","partial","invalid","unknown","disabled","unsubscribed_hypervisor"]},{"name":"subscription_uuid","type":"string"},{"name":"trace_app","type":"string"},{"name":"trace_app_type","type":"string"},{"name":"trace_helper","type":"string"},{"name":"trace_status","values":["reboot_needed","process_restart_needed","updated"]},{"name":"upgradable_rpms","type":"string"},{"name":"usage","type":"text"},{"name":"usage_status","values":["mismatched","matched","not_specified"]},{"name":"user.firstname","type":"string"},{"name":"user.lastname","type":"string"},{"name":"user.login","type":"string"},{"name":"user.mail","type":"string"},{"name":"usergroup","type":"string"},{"name":"usergroup.name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/show","name":"show","apis":[{"api_url":"/api/hosts/:id","http_method":"GET","short_description":"Show a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"openscap_proxy_id","full_name":"host[openscap_proxy_id]","description":"\n\u003cp\u003eID of OpenSCAP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e, \u003ccode\u003ebootdisk\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]},{"name":"ansible_role_ids","full_name":"host[ansible_role_ids]","description":"\n\u003cp\u003eIDs of associated ansible roles\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"openscap_proxy_id","full_name":"host[openscap_proxy_id]","description":"\n\u003cp\u003eID of OpenSCAP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e, \u003ccode\u003ebootdisk\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]},{"name":"ansible_role_ids","full_name":"host[ansible_role_ids]","description":"\n\u003cp\u003eIDs of associated ansible roles\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/enc","name":"enc","apis":[{"api_url":"/api/hosts/:id/enc","http_method":"GET","short_description":"Get ENC values of host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eglobal\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003econfiguration\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003ebuild\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eHostStatus::Global\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/forget_status","name":"forget_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"DELETE","short_description":"Clear sub-status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eClears a host sub-status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host\u0026#39;s compute attributes that can be used to create a clone\nof this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot),\n(cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power_status","name":"power_status","apis":[{"api_url":"/api/hosts/:id/power","http_method":"GET","short_description":"Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/boot","name":"boot","apis":[{"api_url":"/api/hosts/:id/boot","http_method":"PUT","short_description":"Boot host from specified device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/facts","name":"facts","apis":[{"api_url":"/api/hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE,\nprovision, finish, script, user_data, ZTP, POAP, cloud-init, Bootdisk\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/host_collections","name":"host_collections","apis":[{"api_url":"/api/hosts/:host_id/host_collections","http_method":"PUT","short_description":"Alter a hosts host collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eThe id of the host to alter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/play_roles","name":"play_roles","apis":[{"api_url":"/api/hosts/:id/play_roles","http_method":"POST","short_description":"Runs all Ansible roles on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/multiple_play_roles","name":"multiple_play_roles","apis":[{"api_url":"/api/hosts/multiple_play_roles","http_method":"POST","short_description":"Runs all Ansible roles on hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eIDs of hosts to play roles on\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/ansible_roles","name":"ansible_roles","apis":[{"api_url":"/api/hosts/:id/ansible_roles","http_method":"GET","short_description":"List all Ansible roles for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/assign_ansible_roles","name":"assign_ansible_roles","apis":[{"api_url":"/api/hosts/:id/assign_ansible_roles","http_method":"POST","short_description":"Assigns Ansible roles to a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ansible_role_ids","full_name":"ansible_role_ids","description":"\n\u003cp\u003eAnsible roles to assign to a host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/policies_enc","name":"policies_enc","apis":[{"api_url":"/api/hosts/:id/policies_enc","http_method":"GET","short_description":"Show config information for foreman_scap_client","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe identifier of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"interfaces":{"doc_url":"../apidoc/v2/interfaces","id":"interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/interfaces/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"GET","short_description":"List all interfaces for host","deprecated":null},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"GET","short_description":"Show an interface for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"POST","short_description":"Create an interface on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"DELETE","short_description":"Delete a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","id":"hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/hostgroups","http_method":"GET","short_description":"List all host groups for a Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"parameters\"]","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"class","type":"string"},{"name":"config_group","type":"string"},{"name":"content_source","type":"string"},{"name":"content_view","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"medium","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"params","type":"text"},{"name":"template","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/show","name":"show","apis":[{"api_url":"/api/hostgroups/:id","http_method":"GET","short_description":"Show a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/create","name":"create","apis":[{"api_url":"/api/hostgroups","http_method":"POST","short_description":"Create a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"openscap_proxy_id","full_name":"hostgroup[openscap_proxy_id]","description":"\n\u003cp\u003eID of OpenSCAP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ansible_role_ids","full_name":"hostgroup[ansible_role_ids]","description":"\n\u003cp\u003eIDs of associated ansible roles\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/update","name":"update","apis":[{"api_url":"/api/hostgroups/:id","http_method":"PUT","short_description":"Update a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"openscap_proxy_id","full_name":"hostgroup[openscap_proxy_id]","description":"\n\u003cp\u003eID of OpenSCAP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ansible_role_ids","full_name":"hostgroup[ansible_role_ids]","description":"\n\u003cp\u003eIDs of associated ansible roles\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:id","http_method":"DELETE","short_description":"Delete a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/clone","name":"clone","apis":[{"api_url":"/api/hostgroups/:id/clone","http_method":"POST","short_description":"Clone a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hostgroups/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"children_hosts","full_name":"children_hosts","description":"\n\u003cp\u003eOperate on child hostgroup hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/play_roles","name":"play_roles","apis":[{"api_url":"/api/hostgroups/:id/play_roles","http_method":"POST","short_description":"Runs all Ansible roles on a hostgroup","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/multiple_play_roles","name":"multiple_play_roles","apis":[{"api_url":"/api/hostgroups/multiple_play_roles","http_method":"POST","short_description":"Runs all Ansible roles on hostgroups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"hostgroup_ids","description":"\n\u003cp\u003eIDs of hostgroups to play roles on\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/ansible_roles","name":"ansible_roles","apis":[{"api_url":"/api/hostgroups/:id/ansible_roles","http_method":"GET","short_description":"List all Ansible roles for a hostgroup","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/assign_ansible_roles","name":"assign_ansible_roles","apis":[{"api_url":"/api/hostgroups/:id/assign_ansible_roles","http_method":"POST","short_description":"Assigns Ansible roles to a hostgroup","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ansible_role_ids","full_name":"ansible_role_ids","description":"\n\u003cp\u003eAnsible roles to assign to a hostgroup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxies":{"doc_url":"../apidoc/v2/smart_proxies","id":"smart_proxies","api_url":"/api","name":"Smart proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxies/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"feature","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/show","name":"show","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/create","name":"create","apis":[{"api_url":"/api/smart_proxies","http_method":"POST","short_description":"Create a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/update","name":"update","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"PUT","short_description":"Update a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"DELETE","short_description":"Delete a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/refresh","name":"refresh","apis":[{"api_url":"/api/smart_proxies/:id/refresh","http_method":"PUT","short_description":"Refresh smart proxy features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"fact_values":{"doc_url":"../apidoc/v2/fact_values","id":"fact_values","api_url":"/api","name":"Fact values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/fact_values/index","name":"index","apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fact","type":"string"},{"name":"fact_short_name","type":"string"},{"name":"facts","type":"string"},{"name":"host","type":"string"},{"name":"host.hostgroup","type":"string"},{"name":"host_id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"reported_at","type":"datetime"},{"name":"short_name","type":"string"},{"name":"type","type":"string"},{"name":"value","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_inputs":{"doc_url":"../apidoc/v2/template_inputs","id":"template_inputs","api_url":"/api","name":"Template inputs","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_inputs/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"GET","short_description":"List template inputs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"input_type","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"GET","short_description":"Show template input details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"POST","short_description":"Create a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eAnsibleRole\u003c/code\u003e, \u003ccode\u003eAnsibleVariable\u003c/code\u003e, \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDiscoveryRule\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ArfReport\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::Policy\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ScapContent\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::TailoringFile\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eForemanVirtWhoConfigure::Config\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::GpgKey\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplate\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eTrend\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"DELETE","short_description":"Delete a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"PUT","short_description":"Update a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eAnsibleRole\u003c/code\u003e, \u003ccode\u003eAnsibleVariable\u003c/code\u003e, \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDiscoveryRule\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ArfReport\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::Policy\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ScapContent\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::TailoringFile\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eForemanVirtWhoConfigure::Config\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::GpgKey\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplate\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eTrend\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"architectures":{"doc_url":"../apidoc/v2/architectures","id":"architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_kinds":{"doc_url":"../apidoc/v2/template_kinds","id":"template_kinds","api_url":"/api","name":"Template kinds","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_kinds/index","name":"index","apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"audits":{"doc_url":"../apidoc/v2/audits","id":"audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"action","type":"string"},{"name":"auditable_id","type":"integer"},{"name":"changes","type":"text"},{"name":"comment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"interface_fqdn","type":"string"},{"name":"interface_ip","type":"string"},{"name":"interface_mac","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_title","type":"string"},{"name":"parameter","type":"string"},{"name":"partition_table","type":"string"},{"name":"provisioning_template","type":"string"},{"name":"puppetclass","type":"string"},{"name":"remote_address","type":"string"},{"name":"request_uuid","type":"string"},{"name":"setting","type":"string"},{"name":"time","type":"datetime"},{"name":"type","values":["role","ptable","provisioning_template","user","filter","katello/repository","hostgroup","smart_proxy","katello/host/content_facet","katello/host/subscription_facet","remote_execution_feature","usergroup","katello/content_view","katello/kt_environment","subnet","environment","http_proxy","lookup_value","model","domain","realm","architecture","image","katello/host_collection","hostgroup_class","puppetclass","medium","job_template","bookmark","auth_source","compute_resource","host","interface","location","organization","os","override_value","parameter","partition_table","setting","smart_class_parameter"]},{"name":"user","type":"string"},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"personal_access_tokens":{"doc_url":"../apidoc/v2/personal_access_tokens","id":"personal_access_tokens","api_url":"/api","name":"Personal access tokens","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/personal_access_tokens/index","name":"index","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"GET","short_description":"List all Personal Access Tokens for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/show","name":"show","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"GET","short_description":"Show a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/create","name":"create","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"POST","short_description":"Create a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"personal_access_token","full_name":"personal_access_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"personal_access_token[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"personal_access_token[expires_at]","description":"\n\u003cp\u003eExpiry Date\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"DELETE","short_description":"Revoke a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_externals":{"doc_url":"../apidoc/v2/auth_source_externals","id":"auth_source_externals","api_url":"/api","name":"Auth source externals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_externals/index","name":"index","apis":[{"api_url":"/api/auth_source_externals","http_method":"GET","short_description":"List external authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/show","name":"show","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"GET","short_description":"Show an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/update","name":"update","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"PUT","short_description":"Update an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_external","full_name":"auth_source_external","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_external[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_external[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_external[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ping":{"doc_url":"../apidoc/v2/ping","id":"ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ping/ping","name":"ping","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/statuses","name":"statuses","apis":[{"api_url":"/api/statuses","http_method":"GET","short_description":"Shows status and version information of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/index","name":"index","apis":[{"api_url":"/katello/api/ping","http_method":"GET","short_description":"Shows status of Katello system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/server_status","name":"server_status","apis":[{"api_url":"/katello/api/status","http_method":"GET","short_description":"Shows version information","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"auth_source_internals":{"doc_url":"../apidoc/v2/auth_source_internals","id":"auth_source_internals","api_url":"/api","name":"Auth source internals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_internals/index","name":"index","apis":[{"api_url":"/api/auth_source_internals","http_method":"GET","short_description":"List internal authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_internals/show","name":"show","apis":[{"api_url":"/api/auth_source_internals/:id","http_method":"GET","short_description":"Show an internal authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"plugins":{"doc_url":"../apidoc/v2/plugins","id":"plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_ldaps":{"doc_url":"../apidoc/v2/auth_source_ldaps","id":"auth_source_ldaps","api_url":"/api","name":"Auth source ldaps","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_ldaps/index","name":"index","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all LDAP authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/show","name":"show","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/create","name":"create","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"POST","short_description":"Create an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/update","name":"update","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/destroy","name":"destroy","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"trends":{"doc_url":"../apidoc/v2/trends","id":"trends","api_url":"/api","name":"Trends","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/trends/index","name":"index","apis":[{"api_url":"/api/trends","http_method":"GET","short_description":"List of trends counters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/show","name":"show","apis":[{"api_url":"/api/trends/:id","http_method":"GET","short_description":"Show a trend","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/create","name":"create","apis":[{"api_url":"/api/trends","http_method":"POST","short_description":"Create a trend counter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"trendable_type","full_name":"trendable_type","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eFactName\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"fact_name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/destroy","name":"destroy","apis":[{"api_url":"/api/trends/:id","http_method":"DELETE","short_description":"Delete a trend counter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_sources":{"doc_url":"../apidoc/v2/auth_sources","id":"auth_sources","api_url":"/api","name":"Auth sources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_sources/index","name":"index","apis":[{"api_url":"/api/auth_sources","http_method":"GET","short_description":"List all authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"usergroups":{"doc_url":"../apidoc/v2/usergroups","id":"usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUser groups linked to external groups (LDAP) are automatically synced with\nthese groups on update. Remember this synchronization will remove any LDAP\nusers manually added to the Foreman user group. Only LDAP users in the\nexternal groups will remain. Internal users can be added or removed freely.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"autosign":{"doc_url":"../apidoc/v2/autosign","id":"autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/create","name":"create","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"POST","short_description":"Create autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign/:id","http_method":"DELETE","short_description":"Delete autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"../apidoc/v2/users","id":"users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/auth_source_externals/:auth_source_external_id/users","http_method":"GET","short_description":"List all users for external authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"admin","values":["true","false"]},{"name":"auth_source","type":"string"},{"name":"auth_source_type","type":"string"},{"name":"description","type":"text"},{"name":"firstname","type":"string"},{"name":"last_login_on","type":"datetime"},{"name":"lastname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"login","type":"string"},{"name":"mail","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"usergroup","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show_current","name":"show_current","apis":[{"api_url":"/api/current_user","http_method":"GET","short_description":"Show the currently logged-in user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user if it is not already present.\nOnly another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eRequired when user want to change own password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","id":"bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"controller","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/create","name":"create","apis":[{"api_url":"/api/bookmarks","http_method":"POST","short_description":"Create a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"provisioning_templates":{"doc_url":"../apidoc/v2/provisioning_templates","id":"provisioning_templates","api_url":"/api","name":"Provisioning templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default_template","values":["true","false"]},{"name":"environment","type":"string"},{"name":"hostgroup","type":"string"},{"name":"kind","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"operatingsystem","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/create","name":"create","apis":[{"api_url":"/api/provisioning_templates","http_method":"POST","short_description":"Create a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/import","name":"import","apis":[{"api_url":"/api/provisioning_templates/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/build_pxe_default","name":"build_pxe_default","apis":[{"api_url":"/api/provisioning_templates/build_pxe_default","http_method":"POST","short_description":"Update the default PXE menu on all configured TFTP servers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/export","name":"export","apis":[{"api_url":"/api/provisioning_templates/:id/export","http_method":"GET","short_description":"Export a provisioning template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"common_parameters":{"doc_url":"../apidoc/v2/common_parameters","id":"common_parameters","api_url":"/api","name":"Common parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/create","name":"create","apis":[{"api_url":"/api/common_parameters","http_method":"POST","short_description":"Create a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ptables":{"doc_url":"../apidoc/v2/ptables","id":"ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"family","type":"string"},{"name":"layout","type":"text"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/create","name":"create","apis":[{"api_url":"/api/ptables","http_method":"POST","short_description":"Create a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/import","name":"import","apis":[{"api_url":"/api/ptables/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"ptable[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/export","name":"export","apis":[{"api_url":"/api/ptables/:id/export","http_method":"GET","short_description":"Export a partition template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","id":"compute_attributes","api_url":"/api","name":"Compute attributes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_attributes/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute profile","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"List of compute attributes","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"\n\u003cp\u003eID of compute profile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute_resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compute_profile","type":"string"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppetclasses":{"doc_url":"../apidoc/v2/puppetclasses","id":"puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all Puppet classes","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"key","type":"string"},{"name":"location","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","id":"compute_profiles","api_url":"/api","name":"Compute profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/create","name":"create","apis":[{"api_url":"/api/compute_profiles","http_method":"POST","short_description":"Create a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_hosts":{"doc_url":"../apidoc/v2/puppet_hosts","id":"puppet_hosts","api_url":"/api","name":"Puppet hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_resources":{"doc_url":"../apidoc/v2/compute_resources","id":"compute_resources","api_url":"/api","name":"Compute resources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_resources/index","name":"index","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show","name":"show","apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/create","name":"create","apis":[{"api_url":"/api/compute_resources","http_method":"POST","short_description":"Create a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/update","name":"update","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_images","name":"available_images","apis":[{"api_url":"/api/compute_resources/:id/available_images","http_method":"GET","short_description":"List available images for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_clusters","name":"available_clusters","apis":[{"api_url":"/api/compute_resources/:id/available_clusters","http_method":"GET","short_description":"List available clusters for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_flavors","name":"available_flavors","apis":[{"api_url":"/api/compute_resources/:id/available_flavors","http_method":"GET","short_description":"List available flavors for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_folders","name":"available_folders","apis":[{"api_url":"/api/compute_resources/:id/available_folders","http_method":"GET","short_description":"List available folders for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_zones","name":"available_zones","apis":[{"api_url":"/api/compute_resources/:id/available_zones","http_method":"GET","short_description":"List available zone for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_networks","name":"available_networks","apis":[{"api_url":"/api/compute_resources/:id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_resource_pools","name":"available_resource_pools","apis":[{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools","http_method":"GET","short_description":"List resource pools for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_domain","name":"storage_domain","apis":[{"api_url":"/api/compute_resources/:id/storage_domains/:storage_domain_id","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain_id","full_name":"storage_domain_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_pod","name":"storage_pod","apis":[{"api_url":"/api/compute_resources/:id/storage_pods/:storage_pod_id","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod_id","full_name":"storage_pod_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/refresh_cache","name":"refresh_cache","apis":[{"api_url":"/api/compute_resources/:id/refresh_cache","http_method":"PUT","short_description":"Refresh Compute Resource Cache","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_virtual_machines","name":"available_virtual_machines","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines","http_method":"GET","short_description":"List available virtual machines for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show_vm","name":"show_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"GET","short_description":"Show a virtual machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/power_vm","name":"power_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id/power","http_method":"PUT","short_description":"Power a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy_vm","name":"destroy_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"DELETE","short_description":"Delete a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_groups":{"doc_url":"../apidoc/v2/config_groups","id":"config_groups","api_url":"/api","name":"Config groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_groups/index","name":"index","apis":[{"api_url":"/api/config_groups","http_method":"GET","short_description":"List of config groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"class","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/show","name":"show","apis":[{"api_url":"/api/config_groups/:id","http_method":"GET","short_description":"Show a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/create","name":"create","apis":[{"api_url":"/api/config_groups","http_method":"POST","short_description":"Create a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/update","name":"update","apis":[{"api_url":"/api/config_groups/:id","http_method":"PUT","short_description":"Update a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/destroy","name":"destroy","apis":[{"api_url":"/api/config_groups/:id","http_method":"DELETE","short_description":"Delete a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"realms":{"doc_url":"../apidoc/v2/realms","id":"realms","api_url":"/api","name":"Realms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/create","name":"create","apis":[{"api_url":"/api/realms","http_method":"POST","short_description":"Create a realm","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003ename\u003c/strong\u003e field is used for the name of the realm.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_reports":{"doc_url":"../apidoc/v2/config_reports","id":"config_reports","api_url":"/api","name":"Config reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"applied","type":"integer"},{"name":"environment","type":"string"},{"name":"eventful","values":["true","false"]},{"name":"failed","type":"integer"},{"name":"failed_restarts","type":"integer"},{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"log","type":"text"},{"name":"organization","type":"string"},{"name":"origin","type":"string"},{"name":"pending","type":"integer"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"restarted","type":"integer"},{"name":"skipped","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/create","name":"create","apis":[{"api_url":"/api/config_reports","http_method":"POST","short_description":"Create a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"../apidoc/v2/dashboard","id":"dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"domains":{"doc_url":"../apidoc/v2/domains","id":"domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman considers a domain and a DNS zone as the same thing. That is, if\nyou are planning to manage a site where all the machines are of the form\n\u003cem\u003ehostname\u003c/em\u003e.\u003cstrong\u003esomewhere.com\u003c/strong\u003e then the domain is\n\u003cstrong\u003esomewhere.com\u003c/strong\u003e. This allows Foreman to associate a puppet\nvariable with a domain/site and automatically append this variable to all\nexternal node requests made by machines at that site.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fullname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/show","name":"show","apis":[{"api_url":"/api/domains/:id","http_method":"GET","short_description":"Show a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003efullname\u003c/strong\u003e field is used for human readability in\nreports and other pages that refer to domains, and also available as an\nexternal node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"environments":{"doc_url":"../apidoc/v2/environments","id":"environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/environments/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/environments","http_method":"GET","short_description":"List environments of Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/environments","http_method":"GET","short_description":"List environments per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view","type":"string"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"report_templates":{"doc_url":"../apidoc/v2/report_templates","id":"report_templates","api_url":"/api","name":"Report templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/report_templates/index","name":"index","apis":[{"api_url":"/api/report_templates","http_method":"GET","short_description":"List all report templates","deprecated":null},{"api_url":"/api/locations/:location_id/report_templates","http_method":"GET","short_description":"List all report templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/report_templates","http_method":"GET","short_description":"List all report templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/show","name":"show","apis":[{"api_url":"/api/report_templates/:id","http_method":"GET","short_description":"Show a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/create","name":"create","apis":[{"api_url":"/api/report_templates","http_method":"POST","short_description":"Create a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/import","name":"import","apis":[{"api_url":"/api/report_templates/import","http_method":"POST","short_description":"Import a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/revision","name":"revision","apis":[{"api_url":"/api/report_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/update","name":"update","apis":[{"api_url":"/api/report_templates/:id","http_method":"PUT","short_description":"Update a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/destroy","name":"destroy","apis":[{"api_url":"/api/report_templates/:id","http_method":"DELETE","short_description":"Delete a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/clone","name":"clone","apis":[{"api_url":"/api/report_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/export","name":"export","apis":[{"api_url":"/api/report_templates/:id/export","http_method":"GET","short_description":"Export a report template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/generate","name":"generate","apis":[{"api_url":"/api/report_templates/:id/generate","http_method":"POST","short_description":"Generate report from a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report uzing gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/schedule_report","name":"schedule_report","apis":[{"api_url":"/api/report_templates/:id/schedule_report","http_method":"POST","short_description":"Schedule generating of a report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe reports are generated asynchronously. If mail_to is not given, action\nreturns an url to get resulting report from (see\n\u003cstrong\u003ereport_data\u003c/strong\u003e).\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report using gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mail_to","full_name":"mail_to","description":"\n\u003cp\u003eIf set, scheduled report will be delivered via e-mail. Use \u0026#39;,\u0026#39; to\nseparate multiple email addresses.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_at","full_name":"generate_at","description":"\n\u003cp\u003eUTC time to generate report at\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"a successful response","is_array":false,"returns_object":[{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eAn ID of job, which generates report. To be used with report_data API\nendpoint for report data retrieval.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"data_url","full_name":"data_url","description":"\n\u003cp\u003eAn url to get resulting report from. This is not available when report is\ndelivered via e-mail.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["POST /api/report_templates/:id/schedule_report/\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/report_data","name":"report_data","apis":[{"api_url":"/api/report_templates/:id/report_data/:job_id","http_method":"GET","short_description":"Downloads a generated report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the report data as a raw response. In case the report hasn\u0026#39;t\nbeen generated yet, it will return an empty response with http status 204 -\nNoContent.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eID assigned to generating job by the schedule command\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","id":"external_usergroups","api_url":"/api","name":"External usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"filters":{"doc_url":"../apidoc/v2/filters","id":"filters","api_url":"/api","name":"Filters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"limited","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"override","values":["true","false"]},{"name":"permission","type":"string"},{"name":"resource","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"search","type":"text"},{"name":"unlimited","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/create","name":"create","apis":[{"api_url":"/api/filters","http_method":"POST","short_description":"Create a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"home":{"doc_url":"../apidoc/v2/home","id":"home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_classes":{"doc_url":"../apidoc/v2/host_classes","id":"host_classes","api_url":"/api","name":"Host classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_classes/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"../apidoc/v2/roles","id":"roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"builtin","values":["true","false"]},{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"permission","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/clone","name":"clone","apis":[{"api_url":"/api/roles/:id/clone","http_method":"POST","short_description":"Clone a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroup_classes":{"doc_url":"../apidoc/v2/hostgroup_classes","id":"hostgroup_classes","api_url":"/api","name":"Hostgroup classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroup_classes/index","name":"index","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/create","name":"create","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"http_proxies":{"doc_url":"../apidoc/v2/http_proxies","id":"http_proxies","api_url":"/api","name":"Http proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/http_proxies/index","name":"index","apis":[{"api_url":"/api/http_proxies","http_method":"GET","short_description":"List of HTTP Proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/show","name":"show","apis":[{"api_url":"/api/http_proxies/:id","http_method":"GET","short_description":"Show an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eIdentifier of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/create","name":"create","apis":[{"api_url":"/api/http_proxies","http_method":"POST","short_description":"Create an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/update","name":"update","apis":[{"api_url":"/api/http_proxies/:id","http_method":"PUT","short_description":"Update an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/http_proxies/:id","http_method":"DELETE","short_description":"Delete an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"images":{"doc_url":"../apidoc/v2/images","id":"images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/images/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for a compute resource","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"integer"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"},{"name":"operatingsystem","type":"integer"},{"name":"user_data","values":["true","false"]},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"../apidoc/v2/locations","id":"locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/show","name":"show","apis":[{"api_url":"/api/locations/:id","http_method":"GET","short_description":"Show a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/create","name":"create","apis":[{"api_url":"/api/locations","http_method":"POST","short_description":"Create a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"settings":{"doc_url":"../apidoc/v2/settings","id":"settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"mail_notifications":{"doc_url":"../apidoc/v2/mail_notifications","id":"mail_notifications","api_url":"/api","name":"Mail notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"user","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/create","name":"create","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"POST","short_description":"Add an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/update","name":"update","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"PUT","short_description":"Update an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"DELETE","short_description":"Remove an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/user_mail_notifications","name":"user_mail_notifications","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"GET","short_description":"List all email notifications for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"media":{"doc_url":"../apidoc/v2/media","id":"media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"family","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"path","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/create","name":"create","apis":[{"api_url":"/api/media","http_method":"POST","short_description":"Create a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"models":{"doc_url":"../apidoc/v2/models","id":"models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"hardware_model","type":"string"},{"name":"info","type":"text"},{"name":"name","type":"string"},{"name":"vendor_class","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/create","name":"create","apis":[{"api_url":"/api/models","http_method":"POST","short_description":"Create a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"table_preferences":{"doc_url":"../apidoc/v2/table_preferences","id":"table_preferences","api_url":"/api","name":"Table preferences","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/table_preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"GET","short_description":"List of table preferences for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/show","name":"show","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"GET","short_description":"Table preference details of a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/create","name":"create","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"POST","short_description":"Creates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"PUT","short_description":"Updates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"DELETE","short_description":"Delete a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","id":"operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"os_parameters_attributes","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"os_parameters_attributes[name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"os_parameters_attributes[value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"description","type":"string"},{"name":"family","type":"string"},{"name":"major","type":"string"},{"name":"medium","type":"string"},{"name":"minor","type":"string"},{"name":"name","type":"string"},{"name":"params","type":"text"},{"name":"template","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"GET","short_description":"Show an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"organizations":{"doc_url":"../apidoc/v2/organizations","id":"organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/katello/api/organizations","http_method":"GET","short_description":"List all organizations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"GET","short_description":"Show organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/katello/api/organizations","http_method":"POST","short_description":"Create organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"PUT","short_description":"Update organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"redhat_repository_url","full_name":"redhat_repository_url","description":"\n\u003cp\u003eRed Hat CDN URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/repo_discover","name":"repo_discover","apis":[{"api_url":"/katello/api/organizations/:id/repo_discover","http_method":"PUT","short_description":"Discover Repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003eBase URL to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eOne of yum or docker\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch pattern (defaults to \u0026#39;*\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/cancel_repo_discover","name":"cancel_repo_discover","apis":[{"api_url":"/katello/api/organizations/:label/cancel_repo_discover","http_method":"PUT","short_description":"Cancel repository discovery","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003ebase url to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/download_debug_certificate","name":"download_debug_certificate","apis":[{"api_url":"/katello/api/organizations/:label/download_debug_certificate","http_method":"GET","short_description":"Download a debug certificate","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/releases","name":"releases","apis":[{"api_url":"/katello/api/organizations/:id/releases","http_method":"GET","short_description":"List available releases in the organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the Organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/redhat_provider","name":"redhat_provider","apis":[{"api_url":"/katello/api/organizations/:id/redhat_provider","http_method":"GET","short_description":"List all :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"tasks":{"doc_url":"../apidoc/v2/tasks","id":"tasks","api_url":"/api","name":"Tasks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","id":"os_default_templates","api_url":"/api","name":"Os default templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"GET","short_description":"Show a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_combinations":{"doc_url":"../apidoc/v2/template_combinations","id":"template_combinations","api_url":"/api","name":"Template combinations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_combinations/index","name":"index","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/show","name":"show","apis":[{"api_url":"/api/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/destroy","name":"destroy","apis":[{"api_url":"/api/template_combinations/:id","http_method":"DELETE","short_description":"Delete a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"override_values":{"doc_url":"../apidoc/v2/override_values","id":"override_values","api_url":"/api","name":"Override values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/override_values/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/create","name":"create","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/destroy","name":"destroy","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"parameters":{"doc_url":"../apidoc/v2/parameters","id":"parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cstrong\u003enested parameters for a host,\ndomain, subnet, host group, operating system\u003c/strong\u003e. If you are looking\nfor \u0026lt;a href=“common_parameters.html”\u0026gt;global parameters\u0026lt;/a\u0026gt;, go\nto \u0026lt;a href=“common_parameters.html”\u0026gt;this link\u0026lt;/a\u0026gt;.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"GET","short_description":"List all parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"GET","short_description":"List all parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"permissions":{"doc_url":"../apidoc/v2/permissions","id":"permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"resource_type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/resource_types","name":"resource_types","apis":[{"api_url":"/api/permissions/resource_types","http_method":"GET","short_description":"List available resource types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_class_parameters":{"doc_url":"../apidoc/v2/smart_class_parameters","id":"smart_class_parameters","api_url":"/api","name":"Smart class parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_class_parameters/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters","http_method":"GET","short_description":"List all smart class parameters","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific Puppet class","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment/Puppet class combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"avoid_duplicates","values":["true","false"]},{"name":"environment","type":"string"},{"name":"key","type":"string"},{"name":"merge_default","values":["true","false"]},{"name":"merge_overrides","values":["true","false"]},{"name":"override","values":["true","false"]},{"name":"parameter","type":"string"},{"name":"puppetclass","type":"string"},{"name":"puppetclass_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"GET","short_description":"Show a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"PUT","short_description":"Update a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"override","full_name":"smart_class_parameter[override]","description":"\n\u003cp\u003eWhether the smart class parameter value is managed by Foreman\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"smart_class_parameter[description]","description":"\n\u003cp\u003eDescription of smart class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_value","full_name":"smart_class_parameter[default_value]","description":"\n\u003cp\u003eValue to use when there is no match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"smart_class_parameter[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"smart_class_parameter[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output. Puppet will\nuse the value defined in the Puppet manifest for this parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"smart_class_parameter[path]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_type","full_name":"smart_class_parameter[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_rule","full_name":"smart_class_parameter[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value_order","full_name":"smart_class_parameter[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"smart_class_parameter[parameter_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"smart_class_parameter[required]","description":"\n\u003cp\u003eIf true, will raise an error if there is no default value and no matcher\nprovide a value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_overrides","full_name":"smart_class_parameter[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_default","full_name":"smart_class_parameter[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"avoid_duplicates","full_name":"smart_class_parameter[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ssh_keys":{"doc_url":"../apidoc/v2/ssh_keys","id":"ssh_keys","api_url":"/api","name":"Ssh keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ssh_keys/index","name":"index","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"GET","short_description":"List all SSH keys for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/show","name":"show","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"GET","short_description":"Show an SSH key from a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/create","name":"create","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"POST","short_description":"Add an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ssh_key","full_name":"ssh_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ssh_key[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"ssh_key[key]","description":"\n\u003cp\u003ePublic SSH key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"DELETE","short_description":"Delete an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"statistics":{"doc_url":"../apidoc/v2/statistics","id":"statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subnets":{"doc_url":"../apidoc/v2/subnets","id":"subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"boot_mode","type":"string"},{"name":"dns_primary","type":"string"},{"name":"dns_secondary","type":"string"},{"name":"domain","type":"string"},{"name":"gateway","type":"string"},{"name":"ipam","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mask","type":"string"},{"name":"mtu","type":"integer"},{"name":"name","type":"text"},{"name":"network","type":"string"},{"name":"nic_delay","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"text"},{"name":"type","type":"string"},{"name":"vlanid","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/show","name":"show","apis":[{"api_url":"/api/subnets/:id","http_method":"GET","short_description":"Show a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/create","name":"create","apis":[{"api_url":"/api/subnets","http_method":"POST","short_description":"Create a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"discovery_id","full_name":"subnet[discovery_id]","description":"\n\u003cp\u003eID of Discovery Proxy to use within this subnet for managing connection to\ndiscovered hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"discovery_id","full_name":"subnet[discovery_id]","description":"\n\u003cp\u003eID of Discovery Proxy to use within this subnet for managing connection to\ndiscovered hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/freeip","name":"freeip","apis":[{"api_url":"/api/subnets/:id/freeip","http_method":"GET","short_description":"Provides an unused IP address in this subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"mac","description":"\n\u003cp\u003eMAC address to reuse the IP for this host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"excluded_ips","full_name":"excluded_ips","description":"\n\u003cp\u003eIP addresses that should be excluded from suggestion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"recurring_logics":{"doc_url":"../apidoc/v2/recurring_logics","id":"recurring_logics","api_url":"/api","name":"Recurring logics","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/recurring_logics/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/recurring_logics","http_method":"GET","short_description":"List recurring logics","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"GET","short_description":"Show recurring logic details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/update","name":"update","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"PUT","short_description":"Update recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eWhether the recurring logic is enabled or disabled.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/cancel","name":"cancel","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id/cancel","http_method":"POST","short_description":"Cancel recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/bulk_destroy","name":"bulk_destroy","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/bulk_destroy","http_method":"POST","short_description":"Delete recurring logics by search query","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch query\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreman_tasks":{"doc_url":"../apidoc/v2/foreman_tasks","id":"foreman_tasks","api_url":"/api","name":"Foreman tasks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/foreman_tasks/summary","name":"summary","apis":[{"api_url":"/foreman_tasks/api/tasks/summary","http_method":"GET","short_description":"Show task summary","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/tasks/:id","http_method":"GET","short_description":"Show task details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/details","name":"details","apis":[{"api_url":"/foreman_tasks/api/tasks/:id/details","http_method":"GET","short_description":"Show task extended details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/sub_tasks","name":"sub_tasks","apis":[{"api_url":"/foreman_tasks/api/tasks/:id/sub_tasks","http_method":"GET","short_description":"Show sub_tasks details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_search","name":"bulk_search","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_search","http_method":"POST","short_description":"List dynflow tasks for uuids","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eFor every search it returns the list of tasks that satisfty the condition.\nThe reason for supporting multiple searches is the UI that might be ending\nneeding periodic updates on task status for various searches at the same\ntime. This way, it is possible to get all the task statuses with one\nrequest.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"searches","full_name":"searches","description":"\n\u003cp\u003eList of uuids to fetch info about\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"search_id","full_name":"searches[search_id]","description":"\n\u003cp\u003eArbitraty value for client to identify the the request parts with results.\nIt\u0026#39;s passed in the results to be able to pair the requests and\nresponses properly.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"searches[type]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003eresource\u003c/code\u003e, \u003ccode\u003etask\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_id","full_name":"searches[task_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;task\u0026#39;, find the task by the uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"searches[user_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;user\u0026#39;, find tasks for the user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource type we\u0026#39;re searching\nthe tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource id we\u0026#39;re searching\nthe tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"action_types","full_name":"searches[action_types]","description":"\n\u003cp\u003eReturn just tasks of given action type, e.g.\n[“Actions::Katello::Repository::Synchronize”]\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eString\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"active_only","full_name":"searches[active_only]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"searches[page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"searches[per_page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_resume","name":"bulk_resume","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_resume","http_method":"POST","short_description":"Resume all paused error tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eResume tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eResume specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_cancel","name":"bulk_cancel","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_cancel","http_method":"POST","short_description":"Cancel all cancellable tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eCancel tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eCancel specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_stop","name":"bulk_stop","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_stop","http_method":"POST","short_description":"Stop all stoppable tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eStop tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eStop specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/tasks","http_method":"GET","short_description":"List tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, e.g. \u0026#39;name DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of \u0026#39;order\u0026#39; param\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/callback","name":"callback","apis":[{"api_url":"/foreman_tasks/api/tasks/callback","http_method":"POST","short_description":"Send data to the task from external executor (such as smart_proxy_dynflow)","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"callback","full_name":"callback","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"task_id","full_name":"callback[task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"step_id","full_name":"callback[step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"data","full_name":"data","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"callbacks","full_name":"callbacks","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"callback","full_name":"callbacks[callback]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"task_id","full_name":"callbacks[callback][task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"step_id","full_name":"callbacks[callback][step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"data","full_name":"callbacks[data]","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"puppet_modules":{"doc_url":"../apidoc/v2/puppet_modules","id":"puppet_modules","api_url":"/api","name":"Puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea puppet module identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/compare","name":"compare","apis":[{"api_url":"/katello/api/puppet_modules/compare","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"activation_keys":{"doc_url":"../apidoc/v2/activation_keys","id":"activation_keys","api_url":"/api","name":"Activation keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/activation_keys/index","name":"index","apis":[{"api_url":"/katello/api/activation_keys","http_method":"GET","short_description":"List activation keys","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eactivation key name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"addon","type":"string"},{"name":"content_view","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"environment","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"usage","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/create","name":"create","apis":[{"api_url":"/katello/api/activation_keys","http_method":"POST","short_description":"Create an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"\n\u003cp\u003eenvironment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/update","name":"update","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"PUT","short_description":"Update an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"DELETE","short_description":"Destroy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/show","name":"show","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"GET","short_description":"Show an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/copy","name":"copy","apis":[{"api_url":"/katello/api/activation_keys/:id/copy","http_method":"POST","short_description":"Copy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003eName of new activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_host_collections","name":"available_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections/available","http_method":"GET","short_description":"List host collections the activation key does not belong to","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_releases","name":"available_releases","apis":[{"api_url":"/katello/api/activation_keys/:id/releases","http_method":"GET","short_description":"Show release versions available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/product_content","name":"product_content","apis":[{"api_url":"/katello/api/activation_keys/:id/product_content","http_method":"GET","short_description":"Show content available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the activation key\u0026#39;s content\nview version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_host_collections","name":"add_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to associate with activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_host_collections","name":"remove_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to disassociate from the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/add_subscriptions","http_method":"PUT","short_description":"Attach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eQuantity of this subscription to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/remove_subscriptions","http_method":"PUT","short_description":"Unattach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/content_override","name":"content_override","apis":[{"api_url":"/katello/api/activation_keys/:id/content_override","http_method":"PUT","short_description":"Override content for activation_key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters to be added in bulk\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride parameter key or name. Note if name is not provided the default\nname will be \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"repositories_bulk_actions":{"doc_url":"../apidoc/v2/repositories_bulk_actions","id":"repositories_bulk_actions","api_url":"/api","name":"Repositories bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories_bulk_actions/destroy_repositories","name":"destroy_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories_bulk_actions/sync_repositories","name":"sync_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/sync","http_method":"POST","short_description":"Synchronize repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ansible_collections":{"doc_url":"../apidoc/v2/ansible_collections","id":"ansible_collections","api_url":"/api","name":"Ansible Collections","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ansible_collections/index","name":"index","apis":[{"api_url":"/katello/api/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_collections/show","name":"show","apis":[{"api_url":"/katello/api/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean ansible collection identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_collections/compare","name":"compare","apis":[{"api_url":"/katello/api/ansible_collections/compare","http_method":"GET","short_description":"List ansible_collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"repositories":{"doc_url":"../apidoc/v2/repositories","id":"repositories","api_url":"/api","name":"Repositories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories/index","name":"index","apis":[{"api_url":"/katello/api/repositories","http_method":"GET","short_description":"List of enabled repositories","deprecated":null},{"api_url":"/katello/api/content_views/:id/repositories","http_method":"GET","short_description":"List of repositories for a content view","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/repositories","http_method":"GET","short_description":"List of repositories in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id/repositories","http_method":"GET","short_description":"List repositories in the environment","deprecated":null},{"api_url":"/katello/api/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories for a product","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories belonging to a product in an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of an organization to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to show repositories of\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of an environment to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eID of a content view to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eID of a content view version to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_id","full_name":"deb_id","description":"\n\u003cp\u003eId of a deb package to find repositories that contain the deb\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"erratum_id","full_name":"erratum_id","description":"\n\u003cp\u003eId of an erratum to find repositories that contain the erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rpm_id","full_name":"rpm_id","description":"\n\u003cp\u003eId of a rpm package to find repositories that contain the rpm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"file_id","full_name":"file_id","description":"\n\u003cp\u003eId of a file to find repositories that contain the file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_id","full_name":"ansible_collection_id","description":"\n\u003cp\u003eId of an ansible collection to find repositories that contain the ansible\ncollection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_branch_id","full_name":"ostree_branch_id","description":"\n\u003cp\u003eId of an ostree branch to find repositories that contain that branch\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"library","full_name":"library","description":"\n\u003cp\u003eshow repositories in Library and the default content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"archived","full_name":"archived","description":"\n\u003cp\u003eshow archived repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003elimit to only repositories of this type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eyum\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003einterpret specified object to return only Repositories that can be\nassociated with specified object. Only \u0026#39;content_view\u0026#39; \u0026amp;\n\u0026#39;content_view_version\u0026#39; are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"with_content","full_name":"with_content","description":"\n\u003cp\u003eonly repositories having at least one of the specified content type ex: rpm\n, erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003edocker_manifest_list\u003c/code\u003e, \u003ccode\u003edocker_tag\u003c/code\u003e, \u003ccode\u003edocker_blob\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003emodulemd\u003c/code\u003e, \u003ccode\u003eerratum\u003c/code\u003e, \u003ccode\u003edistribution\u003c/code\u003e, \u003ccode\u003epackage_category\u003c/code\u003e, \u003ccode\u003epackage_group\u003c/code\u003e, \u003ccode\u003eyum_repo_metadata_file\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"container_repository_name","type":"string"},{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"distribution_arch","type":"string"},{"name":"distribution_bootable","type":"boolean"},{"name":"distribution_family","type":"string"},{"name":"distribution_uuid","type":"string"},{"name":"distribution_variant","type":"string"},{"name":"distribution_version","type":"string"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"product","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/create","name":"create","apis":[{"api_url":"/katello/api/repositories","http_method":"POST","short_description":"Create a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the repository\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eProduct the repository belongs to\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of repo\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eyum\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39;\nare supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_tags_whitelist","full_name":"docker_tags_whitelist","description":"\n\u003cp\u003eComma separated list of tags to sync for Container Image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either \u0026#39;immediate\u0026#39;,\n\u0026#39;on_demand\u0026#39;, or \u0026#39;background (deprecated)\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eimmediate\u003c/code\u003e, \u003ccode\u003eon_demand\u003c/code\u003e, \u003ccode\u003ebackground\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mirror_on_sync","full_name":"mirror_on_sync","description":"\n\u003cp\u003etrue if this repository when synced has to be mirrored from the source and\nstale rpms removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are\nsigned by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_policy","full_name":"ostree_upstream_sync_policy","description":"\n\u003cp\u003epolicies for syncing upstream ostree repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elatest\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003ecustom\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_depth","full_name":"ostree_upstream_sync_depth","description":"\n\u003cp\u003eif a custom sync policy is chosen for ostree repositories then a\n\u0026#39;depth\u0026#39; value must be provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ecomma separated list of releases to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ecomma separated list of repo components to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ecomma separated list of architectures to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ignore_global_proxy","full_name":"ignore_global_proxy","description":"\n\u003cp\u003eif true, will ignore the globally configured proxy when syncing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/repository_types","name":"repository_types","apis":[{"api_url":"/katello/api/repositories/repository_types","http_method":"GET","short_description":"Show the available repository types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"creatable","full_name":"creatable","description":"\n\u003cp\u003eWhen set to \u0026#39;True\u0026#39; repository types that are creatable will be\nreturned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/republish","name":"republish","apis":[{"api_url":"/katello/api/repositories/:id/republish","http_method":"PUT","short_description":"Forces a republish of the specified repository, regenerating metadata and symlinks on the filesystem.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/show","name":"show","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"GET","short_description":"Show a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/sync","name":"sync","apis":[{"api_url":"/katello/api/repositories/:id/sync","http_method":"POST","short_description":"Sync a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"source_url","full_name":"source_url","description":"\n\u003cp\u003etemporarily override feed URL for sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"incremental","full_name":"incremental","description":"\n\u003cp\u003eperform an incremental import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Only used with yum\nrepositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Only used with yum\nrepositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/export","name":"export","apis":[{"api_url":"/katello/api/repositories/:id/export","http_method":"POST","short_description":"Export a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"PUT","short_description":"Update a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39;\nare supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_tags_whitelist","full_name":"docker_tags_whitelist","description":"\n\u003cp\u003eComma separated list of tags to sync for Container Image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either \u0026#39;immediate\u0026#39;,\n\u0026#39;on_demand\u0026#39;, or \u0026#39;background (deprecated)\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eimmediate\u003c/code\u003e, \u003ccode\u003eon_demand\u003c/code\u003e, \u003ccode\u003ebackground\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mirror_on_sync","full_name":"mirror_on_sync","description":"\n\u003cp\u003etrue if this repository when synced has to be mirrored from the source and\nstale rpms removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are\nsigned by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_policy","full_name":"ostree_upstream_sync_policy","description":"\n\u003cp\u003epolicies for syncing upstream ostree repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elatest\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003ecustom\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_depth","full_name":"ostree_upstream_sync_depth","description":"\n\u003cp\u003eif a custom sync policy is chosen for ostree repositories then a\n\u0026#39;depth\u0026#39; value must be provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ecomma separated list of releases to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ecomma separated list of repo components to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ecomma separated list of architectures to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ignore_global_proxy","full_name":"ignore_global_proxy","description":"\n\u003cp\u003eif true, will ignore the globally configured proxy when syncing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"DELETE","short_description":"Destroy a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/remove_content","name":"remove_content","apis":[{"api_url":"/katello/api/repositories/:id/remove_packages","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_docker_manifests","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_puppet_modules","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_content","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove content from a repository\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of content ids to remove\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/upload_content","name":"upload_content","apis":[{"api_url":"/katello/api/repositories/:id/upload_content","http_method":"POST","short_description":"Upload content into the repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eContent files to upload. Can be a single file or array of files.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/import_uploads","name":"import_uploads","apis":[{"api_url":"/katello/api/repositories/:id/import_uploads","http_method":"PUT","short_description":"Import uploads into a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the ImportUpload action to finish. Default: false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"publish_repository","full_name":"publish_repository","description":"\n\u003cp\u003eWhether or not to regenerate the repository on disk. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uploads","full_name":"uploads","description":"\n\u003cp\u003eArray of uploads to import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"uploads[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_unit_id","full_name":"uploads[content_unit_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"uploads[size]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"checksum","full_name":"uploads[checksum]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"uploads[name]","description":"\n\u003cp\u003eNeeds to only be set for file repositories or docker tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"digest","full_name":"uploads[digest]","description":"\n\u003cp\u003eNeeds to only be set for docker tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/gpg_key_content","name":"gpg_key_content","apis":[{"api_url":"/katello/api/repositories/:id/gpg_key_content","http_method":"GET","short_description":"Return the content of a repo gpg key, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"capsule_content":{"doc_url":"../apidoc/v2/capsule_content","id":"capsule_content","api_url":"/api","name":"Capsule content","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsule_content/lifecycle_environments","name":"lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/available_lifecycle_environments","name":"available_lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/available_lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments not attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/add_lifecycle_environment","name":"add_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"POST","short_description":"Add lifecycle environments to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/remove_lifecycle_environment","name":"remove_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments/:environment_id","http_method":"DELETE","short_description":"Remove lifecycle environments from the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync","name":"sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"POST","short_description":"Synchronize the content to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the environment to limit the synchronization on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eSkip metadata check on each repository on the smart proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync_status","name":"sync_status","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"GET","short_description":"Get current smart proxy synchronization status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to get the status for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/cancel_sync","name":"cancel_sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"DELETE","short_description":"Cancel running smart proxy synchronization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"capsules":{"doc_url":"../apidoc/v2/capsules","id":"capsules","api_url":"/api","name":"Capsules","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsules/index","name":"index","apis":[{"api_url":"/katello/api/capsules","http_method":"GET","short_description":"List all smart proxies that have content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsules/show","name":"show","apis":[{"api_url":"/katello/api/capsules/:id","http_method":"GET","short_description":"Show the smart proxy details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"repository_sets":{"doc_url":"../apidoc/v2/repository_sets","id":"repository_sets","api_url":"/api","name":"Repository sets","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repository_sets/index","name":"index","apis":[{"api_url":"/katello/api/repository_sets","http_method":"GET","short_description":"List repository sets.","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets","http_method":"GET","short_description":"List repository sets for a product.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eRepository set name to search on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eIf true, only return repository sets that have been enabled. Defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"with_active_subscription","full_name":"with_active_subscription","description":"\n\u003cp\u003eIf true, only return repository sets that are associated with an active\nsubscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"with_custom","full_name":"with_custom","description":"\n\u003cp\u003eIf true, return custom repository sets along with redhat repos\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/show","name":"show","apis":[{"api_url":"/katello/api/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/available_repositories","name":"available_repositories","apis":[{"api_url":"/katello/api/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/enable","name":"enable","apis":[{"api_url":"/katello/api/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to enable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/disable","name":"disable","apis":[{"api_url":"/katello/api/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to disable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_credentials":{"doc_url":"../apidoc/v2/content_credentials","id":"content_credentials","api_url":"/api","name":"Content credentials","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eContent Credentials are used to store credentials like GPG Keys and\nCertificates for the authentication to Products / Repositories.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_credentials/index","name":"index","apis":[{"api_url":"/katello/api/content_credentials","http_method":"GET","short_description":"List content credentials","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the Content Credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/create","name":"create","apis":[{"api_url":"/katello/api/content_credentials","http_method":"POST","short_description":"Create a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the content credential\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/show","name":"show","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"GET","short_description":"Show a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/update","name":"update","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"PUT","short_description":"Update a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the content credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"DELETE","short_description":"Destroy a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/content","name":"content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"GET","short_description":"Return the content of a content credential, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/set_content","name":"set_content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"POST","short_description":"Upload content credential contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003efile contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_uploads":{"doc_url":"../apidoc/v2/content_uploads","id":"content_uploads","api_url":"/api","name":"Content uploads","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_uploads/create","name":"create","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads","http_method":"POST","short_description":"Create an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"checksum","full_name":"checksum","description":"\n\u003cp\u003eChecksum of file to upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"PUT","short_description":"Upload a chunk of the file's content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eThe offset in the file where the content starts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eThe actual file contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"DELETE","short_description":"Delete an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"packages":{"doc_url":"../apidoc/v2/packages","id":"packages","api_url":"/api","name":"Packages","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/packages/index","name":"index","apis":[{"api_url":"/katello/api/packages","http_method":"GET","short_description":"List packages","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003ePackage identifiers to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable packages for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_applicable","full_name":"packages_restrict_applicable","description":"\n\u003cp\u003eReturn packages that are applicable to one or more hosts (defaults to true\nif host_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_upgradable","full_name":"packages_restrict_upgradable","description":"\n\u003cp\u003eReturn packages that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_latest","full_name":"packages_restrict_latest","description":"\n\u003cp\u003eReturn only the latest version of each package\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn packages that can be added to the specified object. Only the value\n\u0026#39;content_view_version\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/show","name":"show","apis":[{"api_url":"/katello/api/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/compare","name":"compare","apis":[{"api_url":"/katello/api/packages/compare","http_method":"GET","short_description":"List packages","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_components":{"doc_url":"../apidoc/v2/content_view_components","id":"content_view_components","api_url":"/api","name":"Content view components","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_components/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components","http_method":"GET","short_description":"List components attached to this content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/add_components","name":"add_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/add","http_method":"PUT","short_description":"Add components to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"components","full_name":"components","description":"\n\u003cp\u003eArray of components to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_version_id","full_name":"components[content_view_version_id]","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"components[content_view_id]","description":"\n\u003cp\u003econtent view identifier of the component who\u0026#39;s latest version is\ndesired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"latest","full_name":"components[latest]","description":"\n\u003cp\u003etrue if the latest version of the component\u0026#39;s content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/remove_components","name":"remove_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/remove","http_method":"PUT","short_description":"Remove components from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eArray of content view component IDs to remove. Identifier of the component\nassociation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"GET","short_description":"Show a content view component","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"PUT","short_description":"Update a component associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"latest","full_name":"latest","description":"\n\u003cp\u003etrue if the latest version of the components content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products_bulk_actions":{"doc_url":"../apidoc/v2/products_bulk_actions","id":"products_bulk_actions","api_url":"/api","name":"Products bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products_bulk_actions/destroy_products","name":"destroy_products","apis":[{"api_url":"/katello/api/products/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/sync_products","name":"sync_products","apis":[{"api_url":"/katello/api/products/bulk/sync","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Non-yum repositories\nare skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Non-yum\nrepositories (or those with \nOn Demand download policy) are skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/update_http_proxy","name":"update_http_proxy","apis":[{"api_url":"/katello/api/products/bulk/http_proxy","http_method":"PUT","short_description":"Update the HTTP proxy configuration on the repositories of one or more products.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicy for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eHTTP Proxy identifier to associated\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/update_sync_plans","name":"update_sync_plans","apis":[{"api_url":"/katello/api/products/bulk/sync_plan","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"plan_id","full_name":"plan_id","description":"\n\u003cp\u003eSync plan identifier to attach\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_filter_rules":{"doc_url":"../apidoc/v2/content_view_filter_rules","id":"content_view_filter_rules","api_url":"/api","name":"Content view filter rules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filter_rules/index","name":"index","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"GET","short_description":"List filter rules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerrata_id of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/create","name":"create","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"POST","short_description":"Create a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage, package group, or docker tag names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [String]","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003epackage group: uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eerratum: IDs or a select all object\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"date_type","full_name":"date_type","description":"\n\u003cp\u003eerratum: search using the \u0026#39;Issued On\u0026#39; or \u0026#39;Updated On\u0026#39;\ncolumn of the errata. Values are \u0026#39;issued\u0026#39;/\u0026#39;updated\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"module_stream_ids","full_name":"module_stream_ids","description":"\n\u003cp\u003emodule stream ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/show","name":"show","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"GET","short_description":"Show filter rule info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/update","name":"update","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"PUT","short_description":"Update a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage, package group, or docker tag: name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"DELETE","short_description":"Delete a filter rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"srpms":{"doc_url":"../apidoc/v2/srpms","id":"srpms","api_url":"/api","name":"Srpms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/srpms/index","name":"index","apis":[{"api_url":"/katello/api/srpms","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/srpms/show","name":"show","apis":[{"api_url":"/katello/api/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSRPM details identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/srpms/compare","name":"compare","apis":[{"api_url":"/katello/api/srpms/compare","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_filters":{"doc_url":"../apidoc/v2/content_view_filters","id":"content_view_filters","api_url":"/api","name":"Content view filters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filters/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"get","short_description":"list filters","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"get","short_description":"list filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter content view filters by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003etypes of filters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_type","values":["rpm","package_group","erratum","docker","modulemd"]},{"name":"inclusion_type","values":["include","exclude"]},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the filter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003etype of filter (e.g. rpm, package_group, erratum, docker, modulemd)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package\nfilter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list.\n(module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default:\ninclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"get","short_description":"show filter info","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"get","short_description":"show filter info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"put","short_description":"update a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"put","short_description":"update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003enew name for the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package\nfilter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list.\n(module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default:\ninclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_histories":{"doc_url":"../apidoc/v2/content_view_histories","id":"content_view_histories","api_url":"/api","name":"Content view histories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_histories/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:id/history","http_method":"GET","short_description":"Show a content view's history","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products":{"doc_url":"../apidoc/v2/products","id":"products","api_url":"/api","name":"Products","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products/index","name":"index","apis":[{"api_url":"/katello/api/products","http_method":"GET","short_description":"List products","deprecated":null},{"api_url":"/katello/api/subscriptions/:subscription_id/products","http_method":"GET","short_description":"List of subscription products in a subscription","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/products","http_method":"GET","short_description":"List of subscription products in an activation key","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/products","http_method":"GET","short_description":"List of products in an organization","deprecated":null},{"api_url":"/katello/api/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter products by organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eFilter products by subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eFilter products by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eReturn enabled products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"custom","full_name":"custom","description":"\n\u003cp\u003eReturn custom products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"redhat_only","full_name":"redhat_only","description":"\n\u003cp\u003eReturn Red Hat (non-custom) products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_available_content","full_name":"include_available_content","description":"\n\u003cp\u003eWhether to include available content attribute in results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003eFilter products by sync plan id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Products that can be associated\nwith specified object. Only \u0026#39;sync_plan\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/create","name":"create","apis":[{"api_url":"/katello/api/products","http_method":"POST","short_description":"Create a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/show","name":"show","apis":[{"api_url":"/katello/api/products/:id","http_method":"GET","short_description":"Show a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/update","name":"update","apis":[{"api_url":"/katello/api/products/:id","http_method":"PUT","short_description":"Updates a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/destroy","name":"destroy","apis":[{"api_url":"/katello/api/products/:id","http_method":"DELETE","short_description":"Destroy a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/sync","name":"sync","apis":[{"api_url":"/katello/api/products/:id/sync","http_method":"POST","short_description":"Sync all repositories for a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_view_puppet_modules":{"doc_url":"../apidoc/v2/content_view_puppet_modules","id":"content_view_puppet_modules","api_url":"/api","name":"Content view puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"GET","short_description":"List content view puppet modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003euuid of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"author","type":"string"},{"name":"content_view_name","type":"string"},{"name":"name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"POST","short_description":"Add a puppet module to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ethe id of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"GET","short_description":"Show a content view puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"PUT","short_description":"Update a puppet module associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"DELETE","short_description":"Remove a puppet module from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subscriptions":{"doc_url":"../apidoc/v2/subscriptions","id":"subscriptions","api_url":"/api","name":"Subscriptions","short_description":null,"full_description":"\n\u003cp\u003eSubscriptions management.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions","http_method":"GET","short_description":"List organization subscriptions","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/subscriptions","http_method":"GET","short_description":"List an activation key's subscriptions","deprecated":null},{"api_url":"/katello/api/subscriptions","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of a host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eActivation key ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eObject to show subscriptions available for, either \u0026#39;host\u0026#39; or\n\u0026#39;activation_key\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"match_host","full_name":"match_host","description":"\n\u003cp\u003eIgnore subscriptions that are unavailable to the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"match_installed","full_name":"match_installed","description":"\n\u003cp\u003eReturn subscriptions that match installed products of the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"no_overlap","full_name":"no_overlap","description":"\n\u003cp\u003eReturn subscriptions which do not overlap with a currently-attached\nsubscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null},{"api_url":"/katello/api/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/upload","name":"upload","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/upload","http_method":"POST","short_description":"Upload a subscription manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eSubscription manifest file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]},{"name":"repository_url","full_name":"repository_url","description":"\n\u003cp\u003erepository url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/refresh_manifest","name":"refresh_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/refresh_manifest","http_method":"PUT","short_description":"Refresh previously imported manifest for Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/delete_manifest","name":"delete_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/delete_manifest","http_method":"POST","short_description":"Delete manifest from Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/manifest_history","name":"manifest_history","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/manifest_history","http_method":"GET","short_description":"obtain manifest history for subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_view_versions":{"doc_url":"../apidoc/v2/content_view_versions","id":"content_view_versions","api_url":"/api","name":"Content view versions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_versions/index","name":"index","apis":[{"api_url":"/katello/api/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eFilter versions by environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_module_id","full_name":"puppet_module_id","description":"\n\u003cp\u003eFilter versions by puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003eFilter versions by version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"composite_version_id","full_name":"composite_version_id","description":"\n\u003cp\u003eFilter versions that are components in the specified composite version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"triggered_by_id","full_name":"triggered_by_id","description":"\n\u003cp\u003eFilter composite versions whose publish was triggered by the specified\ncomponent version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"repository","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/show","name":"show","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"GET","short_description":"Show content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/promote","name":"promote","apis":[{"api_url":"/katello/api/content_view_versions/:id/promote","http_method":"POST","short_description":"Promote a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"force","full_name":"force","description":"\n\u003cp\u003eforce content view promotion and bypass lifecycle environment restriction\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eIdentifiers for Lifecycle Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version promotion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/update","name":"update","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"PUT","short_description":"Update a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/republish_repositories","name":"republish_repositories","apis":[{"api_url":"/katello/api/content_view_versions/:id/republish_repositories","http_method":"PUT","short_description":"Forces a republish of the version's repositories' metadata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/export","name":"export","apis":[{"api_url":"/katello/api/content_view_versions/:id/export","http_method":"POST","short_description":"Export a content view version","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"DELETE","short_description":"Remove content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/incremental_update","name":"incremental_update","apis":[{"api_url":"/katello/api/content_view_versions/incremental_update","http_method":"POST","short_description":"Perform an Incremental Update on one or more Content View Versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_environments","full_name":"content_view_version_environments","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_version_id","full_name":"content_view_version_environments[content_view_version_id]","description":"\n\u003cp\u003eContent View Version Ids to perform an incremental update on. May contain\ncomposites as well as one or more components to update.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"content_view_version_environments[environment_ids]","description":"\n\u003cp\u003eThe list of environments to promote the specified Content View Version to\n(replacing the older version)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the new generated Content View Versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resolve_dependencies","full_name":"resolve_dependencies","description":"\n\u003cp\u003eIf true, when adding the specified errata or packages, any needed\ndependencies will be copied as well. Defaults to true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"propagate_all_composites","full_name":"propagate_all_composites","description":"\n\u003cp\u003eIf true, will publish a new composite version using any specified\ncontent_view_version_id that has been promoted to a lifecycle environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"add_content","full_name":"add_content","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"errata_ids","full_name":"add_content[errata_ids]","description":"\n\u003cp\u003eErrata ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"package_ids","full_name":"add_content[package_ids]","description":"\n\u003cp\u003ePackage ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"deb_ids","full_name":"add_content[deb_ids]","description":"\n\u003cp\u003eDeb Package ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"puppet_module_ids","full_name":"add_content[puppet_module_ids]","description":"\n\u003cp\u003ePuppet Module ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"update_hosts","full_name":"update_hosts","description":"\n\u003cp\u003eAfter generating the incremental update, apply the changes to the specified\nhosts. Only Errata are supported currently.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"included","full_name":"update_hosts[included]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"update_hosts[included][search]","description":"\n\u003cp\u003eSearch string for host to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"update_hosts[included][ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"update_hosts[excluded]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"update_hosts[excluded][ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_views":{"doc_url":"../apidoc/v2/content_views","id":"content_views","api_url":"/api","name":"Content views","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_views/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"GET","short_description":"List content views","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"GET","short_description":"List content views","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"nondefault","full_name":"nondefault","description":"\n\u003cp\u003eFilter out default content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"noncomposite","full_name":"noncomposite","description":"\n\u003cp\u003eFilter out composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eFilter only composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"without","full_name":"without","description":"\n\u003cp\u003eDo not include this array of content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"composite","values":["true","false"]},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eContent view label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eComposite content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"PUT","short_description":"Update a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew name for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/publish","name":"publish","apis":[{"api_url":"/katello/api/content_views/:id/publish","http_method":"POST","short_description":"Publish a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the new published content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"major","description":"\n\u003cp\u003eOverride the major version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"minor","description":"\n\u003cp\u003eOverride the minor version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repos_units","full_name":"repos_units","description":"\n\u003cp\u003eSpecify the list of units in each repo\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"label","full_name":"repos_units[label]","description":"\n\u003cp\u003erepo label\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rpm_filenames","full_name":"repos_units[rpm_filenames]","description":"\n\u003cp\u003elist of rpm filename strings to include in published version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"GET","short_description":"Show a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_modules","name":"available_puppet_modules","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_modules","http_method":"GET","short_description":"Get puppet modules that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003emodule name to restrict modules for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_module_names","name":"available_puppet_module_names","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_module_names","http_method":"GET","short_description":"Get puppet modules names that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove_from_environment","name":"remove_from_environment","apis":[{"api_url":"/katello/api/content_views/:id/environments/:environment_id","http_method":"DELETE","short_description":"Remove a content view from an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove","name":"remove","apis":[{"api_url":"/katello/api/content_views/:id/remove","http_method":"PUT","short_description":"Remove versions and/or environments from a content view and reassign systems and keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eenvironment numeric identifiers to be removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view version identifiers to be deleted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"system_content_view_id","full_name":"system_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"system_environment_id","full_name":"system_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"key_content_view_id","full_name":"key_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"key_environment_id","full_name":"key_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"DELETE","short_description":"Delete a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/copy","name":"copy","apis":[{"api_url":"/katello/api/content_views/:id/copy","http_method":"POST","short_description":"Make copy of a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew content view name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"debs":{"doc_url":"../apidoc/v2/debs","id":"debs","api_url":"/api","name":"Deb Packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/debs/index","name":"index","apis":[{"api_url":"/katello/api/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs","http_method":"GET","short_description":"List debs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/debs/show","name":"show","apis":[{"api_url":"/katello/api/debs/:id","http_method":"GET","short_description":"Show a deb","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs/:id","http_method":"GET","short_description":"Show a deb","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea deb identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/debs/compare","name":"compare","apis":[{"api_url":"/katello/api/debs/compare","http_method":"GET","short_description":"List debs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"docker_manifest_lists":{"doc_url":"../apidoc/v2/docker_manifest_lists","id":"docker_manifest_lists","api_url":"/api","name":"Docker manifest lists","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_manifest_lists/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifest_lists/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest list identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifest_lists/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifest_lists/compare","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_manifests":{"doc_url":"../apidoc/v2/docker_manifests","id":"docker_manifests","api_url":"/api","name":"Docker manifests","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_manifests/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifests/compare","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_tags":{"doc_url":"../apidoc/v2/docker_tags","id":"docker_tags","api_url":"/api","name":"Docker tags","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_tags/index","name":"index","apis":[{"api_url":"/katello/api/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/show","name":"show","apis":[{"api_url":"/katello/api/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker tag identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_tags/compare","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/repositories","name":"repositories","apis":[{"api_url":"/katello/api/docker_tags/:id/repositories","http_method":"GET","short_description":"List of repositories for a docker meta tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"lifecycle_environments":{"doc_url":"../apidoc/v2/lifecycle_environments","id":"lifecycle_environments","api_url":"/api","name":"Lifecycle environments","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eAn environment is a basic organization structure that groups hosts,\nproducts, repositories, etc. Every host belongs to one environment and\nit\u0026#39;s isolated inside so that it can see only content that is in its\nenvironment.\u003c/p\u003e\n\n\u003cp\u003e## Chains\u003c/p\u003e\n\n\u003cp\u003eEnvironments are ordered into chains and their content (products,\nrepositories, tempaltes, packages) can be moved to an environment only from\nits prior environment. You can have for example chain like:\u003c/p\u003e\n\n\u003cpre\u003eLibrary -\u0026gt; Development -\u0026gt; Testing -\u0026gt; Production\u003c/pre\u003e\n\n\u003cp\u003eEach change in an environment is done through a changeset in an action\ncalled promotion.\u003c/p\u003e\n\n\u003cp\u003e## Library\u003c/p\u003e\n\n\u003cp\u003eLibrary is a special environment that has no ascendant: All the content\nstarts in this environment. More chains can start from the library\nenvironment but no further branching of a chain is enabled.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/lifecycle_environments/index","name":"index","apis":[{"api_url":"/katello/api/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"library","full_name":"library","description":"\n\u003cp\u003eset true if you want to see only library environments\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter only environments containing this name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/show","name":"show","apis":[{"api_url":"/katello/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/create","name":"create","apis":[{"api_url":"/katello/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"POST","short_description":"Create an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"prior_id","full_name":"prior_id","description":"\n\u003cp\u003eID of an environment that is prior to the new environment in the chain. It\nhas to be either the ID of Library or the ID of an environment at the end\nof a chain.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/update","name":"update","apis":[{"api_url":"/katello/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"PUT","short_description":"Update an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003enew name to be given to the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the update action to finish. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/destroy","name":"destroy","apis":[{"api_url":"/katello/api/environments/:id","http_method":"DELETE","short_description":"Destroy an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"DELETE","short_description":"Destroy an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/paths","name":"paths","apis":[{"api_url":"/katello/api/organizations/:organization_id/environments/paths","http_method":"GET","short_description":"List environment paths","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"permission_type","full_name":"permission_type","description":"\n\u003cp\u003eThe associated permission type. One of (readable | promotable) Default:\nreadable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"errata":{"doc_url":"../apidoc/v2/errata","id":"errata","api_url":"/api","name":"Errata","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/errata/index","name":"index","apis":[{"api_url":"/katello/api/errata","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable errata for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eReturn errata that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn errata that can be added to the specified object. The values\n\u0026#39;content_view_version\u0026#39; and \u0026#39;content_view_filter are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"bug","type":"string"},{"name":"cve","type":"string"},{"name":"errata_id","type":"string"},{"name":"errata_type","type":"string"},{"name":"id","type":"string"},{"name":"issued","type":"date"},{"name":"modular","values":["true","false"]},{"name":"package","type":"string"},{"name":"package_name","type":"string"},{"name":"reboot_suggested","type":"boolean"},{"name":"repository","type":"string"},{"name":"severity","type":"string"},{"name":"title","type":"string"},{"name":"type","type":"string"},{"name":"updated","type":"date"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/show","name":"show","apis":[{"api_url":"/katello/api/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean erratum identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/compare","name":"compare","apis":[{"api_url":"/katello/api/errata/compare","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/available_errata","name":"available_errata","apis":[{"api_url":"/katello/api/content_view_versions/:id/available_errata","http_method":"GET","short_description":"Return errata that can be added to the Content View Version via an Incremental Update","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable errata for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eReturn errata that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"file_units":{"doc_url":"../apidoc/v2/file_units","id":"file_units","api_url":"/api","name":"Files","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/file_units/index","name":"index","apis":[{"api_url":"/katello/api/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files","http_method":"GET","short_description":"List files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/file_units/show","name":"show","apis":[{"api_url":"/katello/api/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea file identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/file_units/compare","name":"compare","apis":[{"api_url":"/katello/api/files/compare","http_method":"GET","short_description":"List files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"gpg_keys":{"doc_url":"../apidoc/v2/gpg_keys","id":"gpg_keys","api_url":"/api","name":"Gpg keys","short_description":null,"full_description":"\n\u003cp\u003e# Description Documents the calls for the list, read, create, update and\ndelete operations for GPG keys\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/gpg_keys/index","name":"index","apis":[{"api_url":"/katello/api/gpg_keys","http_method":"GET","short_description":"List gpg keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/create","name":"create","apis":[{"api_url":"/katello/api/gpg_keys","http_method":"POST","short_description":"Create a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the gpg key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/show","name":"show","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"GET","short_description":"Show a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/update","name":"update","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"PUT","short_description":"Update a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the gpg key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"DELETE","short_description":"Destroy a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/content","name":"content","apis":[{"api_url":"/katello/api/gpg_keys/:id/content","http_method":"GET","short_description":"Return the content of a gpg key, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/set_content","name":"set_content","apis":[{"api_url":"/katello/api/gpg_keys/:id/content","http_method":"POST","short_description":"Upload gpg key contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003efile contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_collections":{"doc_url":"../apidoc/v2/host_collections","id":"host_collections","api_url":"/api","name":"Host collections","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_collections/show","name":"show","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"GET","short_description":"Show a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/index","name":"index","apis":[{"api_url":"/katello/api/host_collections","http_method":"GET","short_description":"List host collections","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"GET","short_description":"List host collections within an organization","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/host_collections","http_method":"GET","short_description":"List host collections in an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eactivation key identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eFilter products by host id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Host Collections that can be\nassociated with specified object. The value \u0026#39;host\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"host","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/create","name":"create","apis":[{"api_url":"/katello/api/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/update","name":"update","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"PUT","short_description":"Update a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/add_hosts","name":"add_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/add_hosts","http_method":"PUT","short_description":"Add host to the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/remove_hosts","name":"remove_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/remove_hosts","http_method":"PUT","short_description":"Remove hosts from the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/destroy","name":"destroy","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"DELETE","short_description":"Destroy a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/copy","name":"copy","apis":[{"api_url":"/katello/api/host_collections/:id/copy","http_method":"POST","short_description":"Make copy of a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew host collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_debs":{"doc_url":"../apidoc/v2/host_debs","id":"host_debs","api_url":"/api","name":"Host debs","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_debs/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/debs","http_method":"GET","short_description":"List deb packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_errata":{"doc_url":"../apidoc/v2/host_errata","id":"host_errata","api_url":"/api","name":"Host errata","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_errata/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/errata","http_method":"GET","short_description":"List errata available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Content View\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/apply","name":"apply","apis":[{"api_url":"/api/hosts/:host_id/errata/apply","http_method":"PUT","short_description":"Schedule errata for installation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids to install\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"\n\u003cp\u003eErrata to exclusively include in the action\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for erratum to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of errata ids to perform an action on, (ex: RHSA-2019:1168)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"\n\u003cp\u003eErrata to explicitly exclude in the action. All other applicable errata\nwill be included in the action, unless an included parameter is passed as\nwell.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of errata ids to exclude and not run an action on, (ex:\nRHSA-2019:1168)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/errata/:id","http_method":"GET","short_description":"Retrieve a single errata for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eErrata id of the erratum (RHSA-2012:108)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/applicability","name":"applicability","apis":[{"api_url":"/api/hosts/:host_id/errata/applicability","http_method":"PUT","short_description":"Force regenerate applicability.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_module_streams":{"doc_url":"../apidoc/v2/host_module_streams","id":"host_module_streams","api_url":"/api","name":"Host module streams","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_module_streams/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/module_streams","http_method":"GET","short_description":"List module streams available to the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eStreams based on the host based on their status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eenabled\u003c/code\u003e, \u003ccode\u003edisabled\u003c/code\u003e, \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003einstalled\u003c/code\u003e, \u003ccode\u003eupgradable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_packages":{"doc_url":"../apidoc/v2/host_packages","id":"host_packages","api_url":"/api","name":"Host packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_packages/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/packages","http_method":"GET","short_description":"List packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"arch","type":"string"},{"name":"epoch","type":"string"},{"name":"name","type":"string"},{"name":"nvra","type":"string"},{"name":"nvrea","type":"string"},{"name":"release","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/install","name":"install","apis":[{"api_url":"/api/hosts/:host_id/packages/install","http_method":"PUT","short_description":"Install packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade","name":"upgrade","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003elist of packages names\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade_all","name":"upgrade_all","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade_all","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/remove","name":"remove","apis":[{"api_url":"/api/hosts/:host_id/packages/remove","http_method":"PUT","short_description":"Uninstall packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_tracer":{"doc_url":"../apidoc/v2/host_tracer","id":"host_tracer","api_url":"/api","name":"Host tracer","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_tracer/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/traces","http_method":"GET","short_description":"List services that need restarting on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_tracer/resolve","name":"resolve","apis":[{"api_url":"/api/traces/resolve","http_method":"PUT","short_description":"Resolve Traces","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"trace_ids","full_name":"trace_ids","description":"\n\u003cp\u003eArray of Trace IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"hosts_bulk_actions":{"doc_url":"../apidoc/v2/hosts_bulk_actions","id":"hosts_bulk_actions","api_url":"/api","name":"Hosts bulk actions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_add_host_collections","name":"bulk_add_host_collections","apis":[{"api_url":"/api/hosts/bulk/add_host_collections","http_method":"PUT","short_description":"Add one or more host collections to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_remove_host_collections","name":"bulk_remove_host_collections","apis":[{"api_url":"/api/hosts/bulk/remove_host_collections","http_method":"PUT","short_description":"Remove one or more host collections from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/applicable_errata","name":"applicable_errata","apis":[{"api_url":"/api/hosts/bulk/applicable_errata","http_method":"POST","short_description":"Fetch applicable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/installable_errata","name":"installable_errata","apis":[{"api_url":"/api/hosts/bulk/installable_errata","http_method":"POST","short_description":"Fetch installable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/install_content","name":"install_content","apis":[{"api_url":"/api/hosts/bulk/install_content","http_method":"PUT","short_description":"Install content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;,\n\u0026#39;package_group\u0026#39; and \u0026#39;errata\u0026#39;.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package names, package group names or errata ids)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/update_content","name":"update_content","apis":[{"api_url":"/api/hosts/bulk/update_content","http_method":"PUT","short_description":"Update content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;\nand \u0026#39;package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"update_all","full_name":"update_all","description":"\n\u003cp\u003eUpdates all packages on the host(s)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/remove_content","name":"remove_content","apis":[{"api_url":"/api/hosts/bulk/remove_content","http_method":"PUT","short_description":"Remove content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;\nand \u0026#39;package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/destroy_hosts","name":"destroy_hosts","apis":[{"api_url":"/api/hosts/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/bulk/remove_subscriptions","http_method":"PUT","short_description":"Remove subscriptions from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of specified subscription to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/bulk/add_subscriptions","http_method":"PUT","short_description":"Add subscriptions to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/bulk/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/content_overrides","name":"content_overrides","apis":[{"api_url":"/api/hosts/bulk/content_overrides","http_method":"PUT","short_description":"Set content overrides to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be\n\u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/environment_content_view","name":"environment_content_view","apis":[{"api_url":"/api/hosts/bulk/environment_content_view","http_method":"PUT","short_description":"Assign the environment and content view to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/release_version","name":"release_version","apis":[{"api_url":"/api/hosts/bulk/release_version","http_method":"PUT","short_description":"Assign the release version to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/traces","name":"traces","apis":[{"api_url":"/api/hosts/bulk/traces","http_method":"POST","short_description":"Fetch traces for one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/available_incremental_updates","name":"available_incremental_updates","apis":[{"api_url":"/api/hosts/bulk/available_incremental_updates","http_method":"POST","short_description":"Given a set of hosts and errata, lists the content view versions and environments that need updating.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/module_streams","name":"module_streams","apis":[{"api_url":"/api/hosts/bulk/module_streams","http_method":"POST","short_description":"Fetch available module streams for hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"module_streams":{"doc_url":"../apidoc/v2/module_streams","id":"module_streams","api_url":"/api","name":"Module streams","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/module_streams/index","name":"index","apis":[{"api_url":"/katello/api/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host id to list available module streams for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"name_stream_only","full_name":"name_stream_only","description":"\n\u003cp\u003eReturn name and stream information only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/module_streams/show","name":"show","apis":[{"api_url":"/katello/api/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea module stream identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/module_streams/compare","name":"compare","apis":[{"api_url":"/katello/api/module_streams/compare","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ostree_branches":{"doc_url":"../apidoc/v2/ostree_branches","id":"ostree_branches","api_url":"/api","name":"Ostree branches","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ostree_branches/index","name":"index","apis":[{"api_url":"/katello/api/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ostree_branches/show","name":"show","apis":[{"api_url":"/katello/api/ostree_branches/:id","http_method":"GET","short_description":"Show an ostree branch","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ostree_branches/:id","http_method":"GET","short_description":"Show an ostree branch","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean ostree branch identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ostree_branches/compare","name":"compare","apis":[{"api_url":"/katello/api/ostree_branches/compare","http_method":"GET","short_description":"List ostree_branches","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"package_groups":{"doc_url":"../apidoc/v2/package_groups","id":"package_groups","api_url":"/api","name":"Package groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/package_groups/index","name":"index","apis":[{"api_url":"/katello/api/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/show","name":"show","apis":[{"api_url":"/katello/api/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package group identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/compare","name":"compare","apis":[{"api_url":"/katello/api/package_groups/compare","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/create","name":"create","apis":[{"api_url":"/katello/api/package_group","http_method":"POST","short_description":"Create a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository_id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003epackage group description. Defaults to \u003ca href=\":name\"\u003eparams\u003c/a\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_visible","full_name":"user_visible","description":"\n\u003cp\u003eset “user_visible” flag on package group. Defaults to true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mandatory_package_names","full_name":"mandatory_package_names","description":"\n\u003cp\u003emandatory package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"optional_package_names","full_name":"optional_package_names","description":"\n\u003cp\u003eoptional package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"conditional_package_names","full_name":"conditional_package_names","description":"\n\u003cp\u003econditional package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default_package_names","full_name":"default_package_names","description":"\n\u003cp\u003edefault package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/destroy","name":"destroy","apis":[{"api_url":"/katello/api/package_group","http_method":"DELETE","short_description":"Delete a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository_id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"sync":{"doc_url":"../apidoc/v2/sync","id":"sync","api_url":"/api","name":"Sync","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/products/:product_id/sync","http_method":"GET","short_description":"Get status of repo synchronisation for given product","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/sync","http_method":"GET","short_description":"Get status of synchronisation for given repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"sync_plans":{"doc_url":"../apidoc/v2/sync_plans","id":"sync_plans","api_url":"/api","name":"Sync plans","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync_plans/index","name":"index","apis":[{"api_url":"/katello/api/sync_plans","http_method":"GET","short_description":"List sync plans","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003efilter by sync date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003efilter by interval\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"enabled","values":["true","false"]},{"name":"interval","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"POST","short_description":"Create a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/add_products","name":"add_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/add_products","http_method":"PUT","short_description":"Add products to sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to add to the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/remove_products","name":"remove_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/remove_products","http_method":"PUT","short_description":"Remove products from sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to remove from the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/sync","name":"sync","apis":[{"api_url":"/katello/api/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"upstream_subscriptions":{"doc_url":"../apidoc/v2/upstream_subscriptions","id":"upstream_subscriptions","api_url":"/api","name":"Upstream subscriptions","short_description":null,"full_description":"\n\u003cp\u003eRed Hat subscriptions management platform.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/upstream_subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"GET","short_description":"List available subscriptions from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eThe order to sort the results in. [\u0026#39;asc\u0026#39;, \u0026#39;desc\u0026#39;] Defaults\nto \u0026#39;desc\u0026#39;.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eThe field to sort the data by. Defaults to the created date.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eReturn only the upstream pools which map to the given Katello pool IDs\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"quantities_only","full_name":"quantities_only","description":"\n\u003cp\u003eOnly returns id and quantity fields\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"attachable","full_name":"attachable","description":"\n\u003cp\u003eReturn only subscriptions which can be attached to the upstream allocation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"PUT","short_description":"Update the quantity of one or more subscriptions on an upstream allocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of Pools to be updated. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eKatello ID of local pool to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eDesired quantity of the pool\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"DELETE","short_description":"Remove one or more subscriptions from an upstream subscription allocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eArray of local pool IDs. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"POST","short_description":"Add subscriptions consumed by a manifest from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of pools to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eCandlepin ID of pool to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eQuantity of entitlements to bind\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/ping","name":"ping","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions/ping","http_method":"GET","short_description":"Check if a connection can be made to Red Hat Subscription Management.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreign_input_sets":{"doc_url":"../apidoc/v2/foreign_input_sets","id":"foreign_input_sets","api_url":"/api","name":"Foreign input sets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/foreign_input_sets/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"GET","short_description":"List foreign input sets","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"GET","short_description":"Show foreign input set details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"POST","short_description":"Create a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"DELETE","short_description":"Delete a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"PUT","short_description":"Update a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_invocations":{"doc_url":"../apidoc/v2/job_invocations","id":"job_invocations","api_url":"/api","name":"Job invocations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/job_invocations/index","name":"index","apis":[{"api_url":"/api/job_invocations","http_method":"GET","short_description":"List job invocations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/show","name":"show","apis":[{"api_url":"/api/job_invocations/:id","http_method":"GET","short_description":"Show job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_status","full_name":"host_status","description":"\n\u003cp\u003eShow Job status for the hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/create","name":"create","apis":[{"api_url":"/api/job_invocations","http_method":"POST","short_description":"Create a job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"job_invocation","full_name":"job_invocation","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"job_template_id","full_name":"job_invocation[job_template_id]","description":"\n\u003cp\u003eThe job template to use, parameter is required unless feature was specified\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"targeting_type","full_name":"job_invocation[targeting_type]","description":"\n\u003cp\u003eInvocation type, one of {“static_query”=\u0026gt;“Static Query”,\n“dynamic_query”=\u0026gt;“Dynamic Query”}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"randomized_ordering","full_name":"job_invocation[randomized_ordering]","description":"\n\u003cp\u003eExecute the jobs on hosts in randomized order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inputs","full_name":"job_invocation[inputs]","description":"\n\u003cp\u003eInputs to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"ssh","full_name":"job_invocation[ssh]","description":"\n\u003cp\u003eSSH provider specific options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"effective_user","full_name":"job_invocation[ssh][effective_user]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms).\nDefaults to a template parameter or global setting.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"recurrence","full_name":"job_invocation[recurrence]","description":"\n\u003cp\u003eCreate a recurring job\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"cron_line","full_name":"job_invocation[recurrence][cron_line]","description":"\n\u003cp\u003eHow often the job should occur, in the cron format\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_iteration","full_name":"job_invocation[recurrence][max_iteration]","description":"\n\u003cp\u003eRepeat a maximum of N times\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"end_time","full_name":"job_invocation[recurrence][end_time]","description":"\n\u003cp\u003ePerform no more executions after this time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"scheduling","full_name":"job_invocation[scheduling]","description":"\n\u003cp\u003eSchedule the job to start at a later time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"start_at","full_name":"job_invocation[scheduling][start_at]","description":"\n\u003cp\u003eSchedule the job for a future time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_before","full_name":"job_invocation[scheduling][start_before]","description":"\n\u003cp\u003eIndicates that the action should be cancelled if it cannot be started\nbefore this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"concurrency_control","full_name":"job_invocation[concurrency_control]","description":"\n\u003cp\u003eControl concurrency level and distribution over time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"time_span","full_name":"job_invocation[concurrency_control][time_span]","description":"\n\u003cp\u003eDistribute tasks over N seconds\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"concurrency_level","full_name":"job_invocation[concurrency_control][concurrency_level]","description":"\n\u003cp\u003eRun at most N tasks at a time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"bookmark_id","full_name":"job_invocation[bookmark_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search_query","full_name":"job_invocation[search_query]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_invocation[description_format]","description":"\n\u003cp\u003eOverride the description format from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"execution_timeout_interval","full_name":"job_invocation[execution_timeout_interval]","description":"\n\u003cp\u003eOverride the timeout interval from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"feature","full_name":"job_invocation[feature]","description":"\n\u003cp\u003eRemote execution feature label that should be triggered, job template\nassigned to this feature will be used\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/output","name":"output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id","http_method":"GET","short_description":"Get output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"since","full_name":"since","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/raw_output","name":"raw_output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id/raw","http_method":"GET","short_description":"Get raw output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/cancel","name":"cancel","apis":[{"api_url":"/api/job_invocations/:id/cancel","http_method":"POST","short_description":"Cancel job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"force","full_name":"force","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/rerun","name":"rerun","apis":[{"api_url":"/api/job_invocations/:id/rerun","http_method":"POST","short_description":"Rerun job on failed hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"failed_only","full_name":"failed_only","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_templates":{"doc_url":"../apidoc/v2/job_templates","id":"job_templates","api_url":"/api","name":"Job templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/job_templates/index","name":"index","apis":[{"api_url":"/api/job_templates","http_method":"GET","short_description":"List job templates","deprecated":null},{"api_url":"/api/locations/:location_id/job_templates","http_method":"GET","short_description":"List job templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/job_templates","http_method":"GET","short_description":"List job templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/import","name":"import","apis":[{"api_url":"/api/job_templates/import","http_method":"POST","short_description":"Import a job template from ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"template","description":"\n\u003cp\u003eTemplate ERB\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overwrite","full_name":"overwrite","description":"\n\u003cp\u003eOverwrite template if it already exists\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/export","name":"export","apis":[{"api_url":"/api/job_templates/:id/export","http_method":"GET","short_description":"Export a job template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/show","name":"show","apis":[{"api_url":"/api/job_templates/:id","http_method":"GET","short_description":"Show job template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/create","name":"create","apis":[{"api_url":"/api/job_templates","http_method":"POST","short_description":"Create a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"job_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e, \u003ccode\u003eAnsible\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the\ninvocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/update","name":"update","apis":[{"api_url":"/api/job_templates/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"job_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e, \u003ccode\u003eAnsible\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the\ninvocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/revision","name":"revision","apis":[{"api_url":"/api/job_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003eTemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/destroy","name":"destroy","apis":[{"api_url":"/api/job_templates/:id","http_method":"DELETE","short_description":"Delete a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/clone","name":"clone","apis":[{"api_url":"/api/job_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"remote_execution_features":{"doc_url":"../apidoc/v2/remote_execution_features","id":"remote_execution_features","api_url":"/api","name":"Remote execution features","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/remote_execution_features/index","name":"index","apis":[{"api_url":"/api/remote_execution_features","http_method":"GET","short_description":"List remote execution features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/remote_execution_features/show","name":"show","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"GET","short_description":"Show remote execution feature","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/remote_execution_features/update","name":"update","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_execution_feature","full_name":"remote_execution_feature","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"job_template_id","full_name":"remote_execution_feature[job_template_id]","description":"\n\u003cp\u003eJob template ID to be used for the feature\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_invocations":{"doc_url":"../apidoc/v2/template_invocations","id":"template_invocations","api_url":"/api","name":"Template invocations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_invocations/template_invocations","name":"template_invocations","apis":[{"api_url":"/api/job_invocations/:job_invocation_id/template_invocations","http_method":"GET","short_description":"List template invocations belonging to job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"job_invocation_id","full_name":"job_invocation_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ansible_inventories":{"doc_url":"../apidoc/v2/ansible_inventories","id":"ansible_inventories","api_url":"/api","name":"Ansible inventories","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ansible_inventories/hosts","name":"hosts","apis":[{"api_url":"/ansible/api/ansible_inventories/hosts","http_method":"POST","short_description":"Show Ansible inventory for hosts","deprecated":null},{"api_url":"/ansible/api/ansible_inventories/hosts","http_method":"GET","short_description":"Show Ansible inventory for hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eIDs of hosts included in inventory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_inventories/hostgroups","name":"hostgroups","apis":[{"api_url":"/ansible/api/ansible_inventories/hostgroups","http_method":"POST","short_description":"Show Ansible inventory for hostgroups","deprecated":null},{"api_url":"/ansible/api/ansible_inventories/hostgroups","http_method":"GET","short_description":"Show Ansible inventory for hostgroups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"hostgroup_ids","description":"\n\u003cp\u003eIDs of hostgroups included in inventory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_inventories/schedule","name":"schedule","apis":[{"api_url":"/ansible/api/ansible_inventories/schedule","http_method":"POST","short_description":"Schedule generating of Ansible Inventory report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values of type input=\u0026gt;value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;json\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /ansible/api/ansible_inventories/schedule\n{\n \"input_values\": {\n \"Organization\": \"yes\",\n \"Location\": \"yes\",\n \"IPv4\": \"yes\",\n \"Facts\": \"no\"\n }\n}\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ansible_override_values":{"doc_url":"../apidoc/v2/ansible_override_values","id":"ansible_override_values","api_url":"/api","name":"Ansible override values","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ansible_override_values/create","name":"create","apis":[{"api_url":"/ansible/api/ansible_override_values","http_method":"POST","short_description":"Create an override value for a specific ansible variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ansible_variable_id","full_name":"ansible_variable_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_override_values/destroy","name":"destroy","apis":[{"api_url":"/ansible/api/ansible_override_values/:id","http_method":"DELETE","short_description":"Destroy an override value","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ansible_roles":{"doc_url":"../apidoc/v2/ansible_roles","id":"ansible_roles","api_url":"/api","name":"Ansible roles","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ansible_roles/show","name":"show","apis":[{"api_url":"/ansible/api/ansible_roles/:id","http_method":"GET","short_description":"Show role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_roles/index","name":"index","apis":[{"api_url":"/ansible/api/ansible_roles","http_method":"GET","short_description":"List Ansible roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_id","type":"integer"},{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"updated_at","type":"datetime"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_roles/destroy","name":"destroy","apis":[{"api_url":"/ansible/api/ansible_roles/:id","http_method":"DELETE","short_description":"Deletes Ansible role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_roles/import","name":"import","apis":[{"api_url":"/ansible/api/ansible_roles/import","http_method":"PUT","short_description":"Import Ansible roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to import from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_names","full_name":"role_names","description":"\n\u003cp\u003eAnsible role names to import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_roles/obsolete","name":"obsolete","apis":[{"api_url":"/ansible/api/ansible_roles/obsolete","http_method":"PUT","short_description":"Obsolete Ansible roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to import from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_roles/fetch","name":"fetch","apis":[{"api_url":"/ansible/api/ansible_roles/fetch","http_method":"GET","short_description":"Fetch Ansible roles available to be imported","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to fetch from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ansible_variables":{"doc_url":"../apidoc/v2/ansible_variables","id":"ansible_variables","api_url":"/api","name":"Ansible variables","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ansible_variables/show","name":"show","apis":[{"api_url":"/ansible/api/ansible_variables/:id","http_method":"GET","short_description":"Show variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_variables/index","name":"index","apis":[{"api_url":"/ansible/api/ansible_variables","http_method":"GET","short_description":"List Ansible variables","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"ansible_role","type":"string"},{"name":"avoid_duplicates","values":["true","false"]},{"name":"imported","values":["true","false"]},{"name":"key","type":"string"},{"name":"merge_default","values":["true","false"]},{"name":"merge_overrides","values":["true","false"]},{"name":"name","type":"string"},{"name":"override","values":["true","false"]},{"name":"parameter","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_variables/destroy","name":"destroy","apis":[{"api_url":"/ansible/api/ansible_variables/:id","http_method":"DELETE","short_description":"Deletes Ansible variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_variables/create","name":"create","apis":[{"api_url":"/ansible/api/ansible_variables","http_method":"POST","short_description":"Create Ansible variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ansible_variable","full_name":"ansible_variable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"variable","full_name":"ansible_variable[variable]","description":"\n\u003cp\u003eName of variable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ansible_role_id","full_name":"ansible_variable[ansible_role_id]","description":"\n\u003cp\u003eRole ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_value","full_name":"ansible_variable[default_value]","description":"\n\u003cp\u003eDefault value of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"ansible_variable[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"override_value_order","full_name":"ansible_variable[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ansible_variable[description]","description":"\n\u003cp\u003eDescription of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_type","full_name":"ansible_variable[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_rule","full_name":"ansible_variable[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_type","full_name":"ansible_variable[variable_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"merge_overrides","full_name":"ansible_variable[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_default","full_name":"ansible_variable[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"avoid_duplicates","full_name":"ansible_variable[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"ansible_variable[override]","description":"\n\u003cp\u003eWhether to override variable or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_variables/update","name":"update","apis":[{"api_url":"/ansible/api/ansible_variables/:id","http_method":"PUT","short_description":"Updates Ansible variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ansible_variable","full_name":"ansible_variable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"variable","full_name":"ansible_variable[variable]","description":"\n\u003cp\u003eName of variable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ansible_role_id","full_name":"ansible_variable[ansible_role_id]","description":"\n\u003cp\u003eRole ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_value","full_name":"ansible_variable[default_value]","description":"\n\u003cp\u003eDefault value of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"ansible_variable[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"override_value_order","full_name":"ansible_variable[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ansible_variable[description]","description":"\n\u003cp\u003eDescription of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_type","full_name":"ansible_variable[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_rule","full_name":"ansible_variable[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_type","full_name":"ansible_variable[variable_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"merge_overrides","full_name":"ansible_variable[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_default","full_name":"ansible_variable[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"avoid_duplicates","full_name":"ansible_variable[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"ansible_variable[override]","description":"\n\u003cp\u003eWhether to override variable or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_variables/import","name":"import","apis":[{"api_url":"/ansible/api/ansible_variables/import","http_method":"PUT","short_description":"Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to import from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_variables/obsolete","name":"obsolete","apis":[{"api_url":"/ansible/api/ansible_variables/obsolete","http_method":"PUT","short_description":"Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to import from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"disks":{"doc_url":"../apidoc/v2/disks","id":"disks","api_url":"/api","name":"Disks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/disks/index","name":"index","apis":[{"api_url":"/bootdisk/api","http_method":"GET","short_description":"Boot disks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/disks/generic","name":"generic","apis":[{"api_url":"/bootdisk/api/generic","http_method":"GET","short_description":"Download generic image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/disks/host","name":"host","apis":[{"api_url":"/bootdisk/api/hosts/:host_id","http_method":"GET","short_description":"Download host image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"full","full_name":"full","description":"\n\u003cp\u003eTrue for full, false for basic reusable image\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"subnet_disks":{"doc_url":"../apidoc/v2/subnet_disks","id":"subnet_disks","api_url":"/api","name":"Subnet disks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnet_disks/index","name":"index","apis":[{"api_url":"/bootdisk/api","http_method":"GET","short_description":"Subnet boot disks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnet_disks/subnet","name":"subnet","apis":[{"api_url":"/bootdisk/api/subnets/:subnet_id","http_method":"GET","short_description":"Download subnet generic image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"discovered_hosts":{"doc_url":"../apidoc/v2/discovered_hosts","id":"discovered_hosts","api_url":"/api","name":"Discovered hosts","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/discovered_hosts/index","name":"index","apis":[{"api_url":"/api/v2/discovered_hosts","http_method":"GET","short_description":"List all discovered hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovered_hosts/show","name":"show","apis":[{"api_url":"/api/v2/discovered_hosts/:id","http_method":"GET","short_description":"Show a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovered_hosts/create","name":"create","apis":[{"api_url":"/api/v2/discovered_hosts","http_method":"POST","short_description":"Create a discovered host for testing (use /facts to create new hosts)","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"discovered_host","full_name":"discovered_host","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"discovered_host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"discovered_host[ip]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"discovered_host[mac]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"discovered_host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2 or PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovered_hosts/update","name":"update","apis":[{"api_url":"/api/v2/discovered_hosts/:id","http_method":"PUT","short_description":"Provision a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"discovered_host","full_name":"discovered_host","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"discovered_host[name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"discovered_host[environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"discovered_host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"discovered_host[mac]","description":"\n\u003cp\u003enot required if it\u0026#39;s a virtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"discovered_host[architecture_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"discovered_host[domain_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"discovered_host[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_ids","full_name":"discovered_host[puppet_class_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"discovered_host[operatingsystem_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"discovered_host[medium_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"discovered_host[ptable_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"discovered_host[subnet_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sp_subnet_id","full_name":"discovered_host[sp_subnet_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"discovered_host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"discovered_host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"discovered_host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"discovered_host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"discovered_host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"discovered_host[host_parameters_attributes]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"build","full_name":"discovered_host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"discovered_host[enabled]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"discovered_host[provision_method]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"discovered_host[managed]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"discovered_host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"discovered_host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"discovered_host[root_pass]","description":"\n\u003cp\u003erequired if value is not inherited from host group or default password in\nsettings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"discovered_host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2 or PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovered_hosts/destroy","name":"destroy","apis":[{"api_url":"/api/v2/discovered_hosts/:id","http_method":"DELETE","short_description":"Delete a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovered_hosts/facts","name":"facts","apis":[{"api_url":"/api/v2/discovered_hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing facts for the host with minimum set of facts:\ndiscovery_bootif, macaddress_eth0, ipaddress, ipaddress_eth0, interfaces:\neth0 (example in case primary interface is named eth0)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovered_hosts/auto_provision","name":"auto_provision","apis":[{"api_url":"/api/v2/discovered_hosts/:id/auto_provision","http_method":"POST","short_description":"Execute rules against a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovered_hosts/auto_provision_all","name":"auto_provision_all","apis":[{"api_url":"/api/v2/discovered_hosts/auto_provision_all","http_method":"POST","short_description":"Execute rules against all currently discovered hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovered_hosts/refresh_facts","name":"refresh_facts","apis":[{"api_url":"/api/v2/discovered_hosts/:id/refresh_facts","http_method":"PUT","short_description":"Refreshing the facts of a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovered_hosts/reboot","name":"reboot","apis":[{"api_url":"/api/v2/discovered_hosts/:id/reboot","http_method":"PUT","short_description":"Rebooting a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovered_hosts/reboot_all","name":"reboot_all","apis":[{"api_url":"/api/v2/discovered_hosts/reboot_all","http_method":"PUT","short_description":"Rebooting all discovered hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"discovery_rules":{"doc_url":"../apidoc/v2/discovery_rules","id":"discovery_rules","api_url":"/api","name":"Discovery rules","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/discovery_rules/index","name":"index","apis":[{"api_url":"/api/v2/discovery_rules","http_method":"GET","short_description":"List all discovery rules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovery_rules/show","name":"show","apis":[{"api_url":"/api/v2/discovery_rules/:id","http_method":"GET","short_description":"Show a discovery rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovery_rules/create","name":"create","apis":[{"api_url":"/api/v2/discovery_rules","http_method":"POST","short_description":"Create a discovery rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"discovery_rule","full_name":"discovery_rule","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"discovery_rule[name]","description":"\n\u003cp\u003erepresents rule name shown to the users\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"discovery_rule[search]","description":"\n\u003cp\u003equery to match discovered hosts for the particular rule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"discovery_rule[hostgroup_id]","description":"\n\u003cp\u003ethe hostgroup that is used to auto provision a host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostname","full_name":"discovery_rule[hostname]","description":"\n\u003cp\u003edefines a pattern to assign human-readable hostnames to the matching hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_count","full_name":"discovery_rule[max_count]","description":"\n\u003cp\u003eenables to limit maximum amount of provisioned hosts per rule\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"priority","full_name":"discovery_rule[priority]","description":"\n\u003cp\u003eputs the rules in order, low numbers go first. Must be greater then zero\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"discovery_rule[enabled]","description":"\n\u003cp\u003eflag is used for temporary shutdown of rules\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"discovery_rule[location_ids]","description":"\n\u003cp\u003elocation ID for provisioned hosts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"discovery_rule[organization_ids]","description":"\n\u003cp\u003eorganization ID for provisioned hosts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovery_rules/update","name":"update","apis":[{"api_url":"/api/v2/discovery_rules/:id","http_method":"PUT","short_description":"Update a rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"discovery_rule","full_name":"discovery_rule","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"discovery_rule[name]","description":"\n\u003cp\u003erepresents rule name shown to the users\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"discovery_rule[search]","description":"\n\u003cp\u003equery to match discovered hosts for the particular rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"discovery_rule[hostgroup_id]","description":"\n\u003cp\u003ethe hostgroup that is used to auto provision a host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostname","full_name":"discovery_rule[hostname]","description":"\n\u003cp\u003edefines a pattern to assign human-readable hostnames to the matching hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_count","full_name":"discovery_rule[max_count]","description":"\n\u003cp\u003eenables to limit maximum amount of provisioned hosts per rule\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"priority","full_name":"discovery_rule[priority]","description":"\n\u003cp\u003eputs the rules in order, low numbers go first. Must be greater then zero\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"discovery_rule[enabled]","description":"\n\u003cp\u003eflag is used for temporary shutdown of rules\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"discovery_rule[location_ids]","description":"\n\u003cp\u003elocation ID for provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"discovery_rule[organization_ids]","description":"\n\u003cp\u003eorganization ID for provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/discovery_rules/destroy","name":"destroy","apis":[{"api_url":"/api/v2/discovery_rules/:id","http_method":"DELETE","short_description":"Delete a rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"arf_reports":{"doc_url":"../apidoc/v2/arf_reports","id":"arf_reports","api_url":"/api","name":"Arf reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/arf_reports/index","name":"index","apis":[{"api_url":"/api/compliance/arf_reports","http_method":"GET","short_description":"List ARF reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compliance_policy","type":"string"},{"name":"compliance_status","values":["compliant","incompliant","inconclusive"]},{"name":"comply_with","type":"string"},{"name":"environment","type":"string"},{"name":"eventful","values":["true","false"]},{"name":"host","type":"string"},{"name":"host_collection","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"inconclusive_with","type":"string"},{"name":"last_for","values":["host","policy"]},{"name":"last_report","type":"datetime"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"log","type":"text"},{"name":"not_comply_with","type":"string"},{"name":"openscap_proxy","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"policy","type":"string"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"xccdf_rule_failed","type":"string"},{"name":"xccdf_rule_name","type":"text"},{"name":"xccdf_rule_othered","type":"string"},{"name":"xccdf_rule_passed","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/arf_reports/show","name":"show","apis":[{"api_url":"/api/compliance/arf_reports/:id","http_method":"GET","short_description":"Show an ARF report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/arf_reports/destroy","name":"destroy","apis":[{"api_url":"/api/compliance/arf_reports/:id","http_method":"DELETE","short_description":"Delete an ARF Report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/arf_reports/create","name":"create","apis":[{"api_url":"/api/compliance/arf/:cname/:policy_id/:date","http_method":"POST","short_description":"Upload an ARF report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cname","full_name":"cname","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"policy_id","full_name":"policy_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"date","full_name":"date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/arf_reports/download","name":"download","apis":[{"api_url":"/api/compliance/arf_reports/:id/download","http_method":"GET","short_description":"Download bzipped ARF report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/arf_reports/download_html","name":"download_html","apis":[{"api_url":"/api/compliance/arf_reports/:id/download_html","http_method":"GET","short_description":"Download ARF report in HTML","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"policies":{"doc_url":"../apidoc/v2/policies","id":"policies","api_url":"/api","name":"Policies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/policies/index","name":"index","apis":[{"api_url":"/api/compliance/policies","http_method":"GET","short_description":"List Policies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"profile","type":"string"},{"name":"tailoring_file","type":"string"},{"name":"tailoring_file_profile","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/policies/show","name":"show","apis":[{"api_url":"/api/compliance/policies/:id","http_method":"GET","short_description":"Show a Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/policies/create","name":"create","apis":[{"api_url":"/api/compliance/policies","http_method":"POST","short_description":"Create a Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"policy","full_name":"policy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"policy[name]","description":"\n\u003cp\u003ePolicy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"policy[description]","description":"\n\u003cp\u003ePolicy description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scap_content_id","full_name":"policy[scap_content_id]","description":"\n\u003cp\u003ePolicy SCAP content ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"scap_content_profile_id","full_name":"policy[scap_content_profile_id]","description":"\n\u003cp\u003ePolicy SCAP content profile ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"period","full_name":"policy[period]","description":"\n\u003cp\u003ePolicy schedule period (weekly, monthly, custom)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"weekday","full_name":"policy[weekday]","description":"\n\u003cp\u003ePolicy schedule weekday (only if period == “weekly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"day_of_month","full_name":"policy[day_of_month]","description":"\n\u003cp\u003ePolicy schedule day of month (only if period == “monthly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cron_line","full_name":"policy[cron_line]","description":"\n\u003cp\u003ePolicy schedule cron line (only if period == “custom”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"policy[hostgroup_ids]","description":"\n\u003cp\u003eApply policy to host groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"policy[host_ids]","description":"\n\u003cp\u003eApply policy to hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"tailoring_file_id","full_name":"policy[tailoring_file_id]","description":"\n\u003cp\u003eTailoring file ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tailoring_file_profile_id","full_name":"policy[tailoring_file_profile_id]","description":"\n\u003cp\u003eTailoring file profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deploy_by","full_name":"policy[deploy_by]","description":"\n\u003cp\u003eHow the policy should be deployed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eansible\u003c/code\u003e, \u003ccode\u003emanual\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"policy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"policy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/policies/update","name":"update","apis":[{"api_url":"/api/compliance/policies/:id","http_method":"PUT","short_description":"Update a Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"policy","full_name":"policy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"policy[name]","description":"\n\u003cp\u003ePolicy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"policy[description]","description":"\n\u003cp\u003ePolicy description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scap_content_id","full_name":"policy[scap_content_id]","description":"\n\u003cp\u003ePolicy SCAP content ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"scap_content_profile_id","full_name":"policy[scap_content_profile_id]","description":"\n\u003cp\u003ePolicy SCAP content profile ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"period","full_name":"policy[period]","description":"\n\u003cp\u003ePolicy schedule period (weekly, monthly, custom)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"weekday","full_name":"policy[weekday]","description":"\n\u003cp\u003ePolicy schedule weekday (only if period == “weekly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"day_of_month","full_name":"policy[day_of_month]","description":"\n\u003cp\u003ePolicy schedule day of month (only if period == “monthly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cron_line","full_name":"policy[cron_line]","description":"\n\u003cp\u003ePolicy schedule cron line (only if period == “custom”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"policy[hostgroup_ids]","description":"\n\u003cp\u003eApply policy to host groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"policy[host_ids]","description":"\n\u003cp\u003eApply policy to hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"tailoring_file_id","full_name":"policy[tailoring_file_id]","description":"\n\u003cp\u003eTailoring file ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tailoring_file_profile_id","full_name":"policy[tailoring_file_profile_id]","description":"\n\u003cp\u003eTailoring file profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deploy_by","full_name":"policy[deploy_by]","description":"\n\u003cp\u003eHow the policy should be deployed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eansible\u003c/code\u003e, \u003ccode\u003emanual\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"policy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"policy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/policies/destroy","name":"destroy","apis":[{"api_url":"/api/compliance/policies/:id","http_method":"DELETE","short_description":"Delete a Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/policies/content","name":"content","apis":[{"api_url":"/api/compliance/policies/:id/content","http_method":"GET","short_description":"Show a policy's SCAP content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/policies/tailoring","name":"tailoring","apis":[{"api_url":"/api/compliance/policies/:id/tailoring","http_method":"GET","short_description":"Show a policy's Tailoring file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"scap_content_profiles":{"doc_url":"../apidoc/v2/scap_content_profiles","id":"scap_content_profiles","api_url":"/api","name":"Scap content profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/scap_content_profiles/index","name":"index","apis":[{"api_url":"/api/compliance/scap_content_profiles","http_method":"GET","short_description":"List SCAP content profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"profile_id","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"scap_contents":{"doc_url":"../apidoc/v2/scap_contents","id":"scap_contents","api_url":"/api","name":"Scap contents","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/scap_contents/index","name":"index","apis":[{"api_url":"/api/compliance/scap_contents","http_method":"GET","short_description":"List SCAP contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"created_at","type":"datetime"},{"name":"filename","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/scap_contents/xml","name":"xml","apis":[{"api_url":"/api/compliance/scap_contents/:id/xml","http_method":"GET","short_description":"Download an SCAP content as XML","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/scap_contents/show","name":"show","apis":[{"api_url":"/api/compliance/scap_contents/:id","http_method":"GET","short_description":"Show an SCAP content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/scap_contents/create","name":"create","apis":[{"api_url":"/api/compliance/scap_contents","http_method":"POST","short_description":"Create SCAP content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"scap_content","full_name":"scap_content","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"title","full_name":"scap_content[title]","description":"\n\u003cp\u003eSCAP content name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scap_file","full_name":"scap_content[scap_file]","description":"\n\u003cp\u003eXML containing SCAP content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_filename","full_name":"scap_content[original_filename]","description":"\n\u003cp\u003eOriginal file name of the XML file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"scap_content[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"scap_content[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/scap_contents/update","name":"update","apis":[{"api_url":"/api/compliance/scap_contents/:id","http_method":"PUT","short_description":"Update an SCAP content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scap_content","full_name":"scap_content","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"title","full_name":"scap_content[title]","description":"\n\u003cp\u003eSCAP content name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scap_file","full_name":"scap_content[scap_file]","description":"\n\u003cp\u003eXML containing SCAP content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_filename","full_name":"scap_content[original_filename]","description":"\n\u003cp\u003eOriginal file name of the XML file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"scap_content[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"scap_content[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/scap_contents/destroy","name":"destroy","apis":[{"api_url":"/api/compliance/scap_contents/:id","http_method":"DELETE","short_description":"Deletes an SCAP content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"tailoring_files":{"doc_url":"../apidoc/v2/tailoring_files","id":"tailoring_files","api_url":"/api","name":"Tailoring files","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tailoring_files/index","name":"index","apis":[{"api_url":"/api/compliance/tailoring_files","http_method":"GET","short_description":"List Tailoring files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"created_at","type":"datetime"},{"name":"filename","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/tailoring_files/xml","name":"xml","apis":[{"api_url":"/api/compliance/tailoring_files/:id/xml","http_method":"GET","short_description":"Download a Tailoring file as XML","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/tailoring_files/show","name":"show","apis":[{"api_url":"/api/compliance/tailoring_files/:id","http_method":"GET","short_description":"Show a Tailoring file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/tailoring_files/create","name":"create","apis":[{"api_url":"/api/compliance/tailoring_files","http_method":"POST","short_description":"Create a Tailoring file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tailoring_file","full_name":"tailoring_file","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"tailoring_file[name]","description":"\n\u003cp\u003eTailoring file name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scap_file","full_name":"tailoring_file[scap_file]","description":"\n\u003cp\u003eXML containing tailoring file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_filename","full_name":"tailoring_file[original_filename]","description":"\n\u003cp\u003eOriginal file name of the XML file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"tailoring_file[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"tailoring_file[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/tailoring_files/update","name":"update","apis":[{"api_url":"/api/compliance/tailoring_files/:id","http_method":"PUT","short_description":"Update a Tailoring file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tailoring_file","full_name":"tailoring_file","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"tailoring_file[name]","description":"\n\u003cp\u003eTailoring file name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scap_file","full_name":"tailoring_file[scap_file]","description":"\n\u003cp\u003eXML containing tailoring file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_filename","full_name":"tailoring_file[original_filename]","description":"\n\u003cp\u003eOriginal file name of the XML file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"tailoring_file[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"tailoring_file[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/tailoring_files/destroy","name":"destroy","apis":[{"api_url":"/api/compliance/tailoring_files/:id","http_method":"DELETE","short_description":"Deletes a Tailoring file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"templates":{"doc_url":"../apidoc/v2/templates","id":"templates","api_url":"/api","name":"Templates","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/templates/import","name":"import","apis":[{"api_url":"/api/templates/import","http_method":"POST","short_description":"Initiate Import","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"prefix","full_name":"prefix","description":"\n\u003cp\u003eThe string all imported templates should begin with.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"associate","description":"\n\u003cp\u003eAssociate to OS\u0026#39;s, Locations \u0026amp; Organizations. Options are: always,\nnew or never.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"force","full_name":"force","description":"\n\u003cp\u003eUpdate templates that are locked\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"lock","description":"\n\u003cp\u003eLock imported templates\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elock\u003c/code\u003e, \u003ccode\u003ekeep_lock_new\u003c/code\u003e, \u003ccode\u003ekeep\u003c/code\u003e, \u003ccode\u003eunlock\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"verbose","full_name":"verbose","description":"\n\u003cp\u003eShow template diff in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"branch","full_name":"branch","description":"\n\u003cp\u003eBranch in Git repo.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repo","full_name":"repo","description":"\n\u003cp\u003eOverride the default repo from settings.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eExport templates with names matching this regex (case-insensitive; snippets\nare not filtered).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"negate","full_name":"negate","description":"\n\u003cp\u003eNegate the prefix (for purging).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"dirname","full_name":"dirname","description":"\n\u003cp\u003eThe directory within Git repo containing the templates\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"location_ids","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"organization_ids","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/templates/export","name":"export","apis":[{"api_url":"/api/templates/export","http_method":"POST","short_description":"Initiate Export","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"metadata_export_mode","full_name":"metadata_export_mode","description":"\n\u003cp\u003eSpecify how to handle metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003erefresh\u003c/code\u003e, \u003ccode\u003ekeep\u003c/code\u003e, \u003ccode\u003eremove\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"commit_msg","full_name":"commit_msg","description":"\n\u003cp\u003eCustom commit message for templates export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"branch","full_name":"branch","description":"\n\u003cp\u003eBranch in Git repo.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repo","full_name":"repo","description":"\n\u003cp\u003eOverride the default repo from settings.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eExport templates with names matching this regex (case-insensitive; snippets\nare not filtered).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"negate","full_name":"negate","description":"\n\u003cp\u003eNegate the prefix (for purging).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"dirname","full_name":"dirname","description":"\n\u003cp\u003eThe directory within Git repo containing the templates\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"location_ids","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"organization_ids","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"configs":{"doc_url":"../apidoc/v2/configs","id":"configs","api_url":"/api","name":"Configs","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/configs/index","name":"index","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs","http_method":"GET","short_description":"List of virt-who configurations","deprecated":null},{"api_url":"/foreman_virt_who_configure/api/v2/organizations/:organization_id/configs","http_method":"GET","short_description":"List of virt-who configurations per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/configs/show","name":"show","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs/:id","http_method":"GET","short_description":"Show a virt-who configuration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/configs/deploy_script","name":"deploy_script","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs/:id/deploy_script","http_method":"GET","short_description":"Renders a deploy script for the specified virt-who configuration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/configs/create","name":"create","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs","http_method":"POST","short_description":"Create a virt-who configuration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"foreman_virt_who_configure_config","full_name":"foreman_virt_who_configure_config","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"foreman_virt_who_configure_config[name]","description":"\n\u003cp\u003eConfiguration name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"foreman_virt_who_configure_config[interval]","description":"\n\u003cp\u003eConfiguration interval in minutes\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e60\u003c/code\u003e, \u003ccode\u003e120\u003c/code\u003e, \u003ccode\u003e240\u003c/code\u003e, \u003ccode\u003e480\u003c/code\u003e, \u003ccode\u003e720\u003c/code\u003e, \u003ccode\u003e1440\u003c/code\u003e, \u003ccode\u003e2880\u003c/code\u003e, \u003ccode\u003e4320\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filtering_mode","full_name":"foreman_virt_who_configure_config[filtering_mode]","description":"\n\u003cp\u003eHypervisor filtering mode, 0 means no filtering, 1 means whitelist, 2 means\nblacklist\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e2\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"whitelist","full_name":"foreman_virt_who_configure_config[whitelist]","description":"\n\u003cp\u003eHypervisor whitelist, applicable only when filtering mode is set to 1.\nWildcards and regular expressions are supported, multiple records must be\nseparated by comma.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"blacklist","full_name":"foreman_virt_who_configure_config[blacklist]","description":"\n\u003cp\u003eHypervisor blacklist, applicable only when filtering mode is set to 2.\nWildcards and regular expressions are supported, multiple records must be\nseparated by comma.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_host_parents","full_name":"foreman_virt_who_configure_config[filter_host_parents]","description":"\n\u003cp\u003eApplicable only for esx provider type. Only hosts which parent (usually\nComputeResource) name is specified in comma-separated list in this option\nwill be reported. Wildcards and regular expressions are supported, multiple\nrecords must be separated by comma. Put the value into the double-quotes if\nit contains special characters like comma. All new line characters will be\nremoved in resulting configuration file, white spaces are removed from\nbeginning and end.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude_host_parents","full_name":"foreman_virt_who_configure_config[exclude_host_parents]","description":"\n\u003cp\u003eApplicable only for esx provider type. Hosts which parent (usually\nComputeResource) name is specified in comma-separated list in this option\nwill \u003cstrong\u003eNOT\u003c/strong\u003e be reported. Wildcards and regular expressions\nare supported, multiple records must be separated by comma. Put the value\ninto the double-quotes if it contains special characters like comma. All\nnew line characters will be removed in resulting configuration file, white\nspaces are removed from beginning and end.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_id","full_name":"foreman_virt_who_configure_config[hypervisor_id]","description":"\n\u003cp\u003eSpecifies how the hypervisor will be identified.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehostname\u003c/code\u003e, \u003ccode\u003euuid\u003c/code\u003e, \u003ccode\u003ehwuuid\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_type","full_name":"foreman_virt_who_configure_config[hypervisor_type]","description":"\n\u003cp\u003eHypervisor type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eesx\u003c/code\u003e, \u003ccode\u003erhevm\u003c/code\u003e, \u003ccode\u003ehyperv\u003c/code\u003e, \u003ccode\u003exen\u003c/code\u003e, \u003ccode\u003elibvirt\u003c/code\u003e, \u003ccode\u003ekubevirt\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_server","full_name":"foreman_virt_who_configure_config[hypervisor_server]","description":"\n\u003cp\u003eFully qualified host name or IP address of the hypervisor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_username","full_name":"foreman_virt_who_configure_config[hypervisor_username]","description":"\n\u003cp\u003eAccount name by which virt-who is to connect to the hypervisor.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_password","full_name":"foreman_virt_who_configure_config[hypervisor_password]","description":"\n\u003cp\u003eHypervisor password, required for all hypervisor types except for libvirt\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"satellite_url","full_name":"foreman_virt_who_configure_config[satellite_url]","description":"\n\u003cp\u003eSatellite server FQDN\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"debug","full_name":"foreman_virt_who_configure_config[debug]","description":"\n\u003cp\u003eEnable debugging output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"proxy","full_name":"foreman_virt_who_configure_config[proxy]","description":"\n\u003cp\u003eHTTP proxy that should be used for communication between the server on\nwhich virt-who is running and the hypervisors and virtualization managers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"no_proxy","full_name":"foreman_virt_who_configure_config[no_proxy]","description":"\n\u003cp\u003eIgnore proxy. A comma-separated list of hostnames or domains or ip\naddresses to ignore proxy settings for. Optionally this may be set to * to\nbypass proxy settings for all hostnames domains or ip addresses.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"foreman_virt_who_configure_config[organization_id]","description":"\n\u003cp\u003eOrganization of the virt-who configuration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/configs/update","name":"update","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs/:id","http_method":"PUT","short_description":"Update a virt-who configuration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eConfiguration numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"foreman_virt_who_configure_config","full_name":"foreman_virt_who_configure_config","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"foreman_virt_who_configure_config[name]","description":"\n\u003cp\u003eConfiguration name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"foreman_virt_who_configure_config[interval]","description":"\n\u003cp\u003eConfiguration interval in minutes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e60\u003c/code\u003e, \u003ccode\u003e120\u003c/code\u003e, \u003ccode\u003e240\u003c/code\u003e, \u003ccode\u003e480\u003c/code\u003e, \u003ccode\u003e720\u003c/code\u003e, \u003ccode\u003e1440\u003c/code\u003e, \u003ccode\u003e2880\u003c/code\u003e, \u003ccode\u003e4320\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filtering_mode","full_name":"foreman_virt_who_configure_config[filtering_mode]","description":"\n\u003cp\u003eHypervisor filtering mode, 0 means no filtering, 1 means whitelist, 2 means\nblacklist\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e2\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"whitelist","full_name":"foreman_virt_who_configure_config[whitelist]","description":"\n\u003cp\u003eHypervisor whitelist, applicable only when filtering mode is set to 1.\nWildcards and regular expressions are supported, multiple records must be\nseparated by comma.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"blacklist","full_name":"foreman_virt_who_configure_config[blacklist]","description":"\n\u003cp\u003eHypervisor blacklist, applicable only when filtering mode is set to 2.\nWildcards and regular expressions are supported, multiple records must be\nseparated by comma.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_host_parents","full_name":"foreman_virt_who_configure_config[filter_host_parents]","description":"\n\u003cp\u003eApplicable only for esx provider type. Only hosts which parent (usually\nComputeResource) name is specified in comma-separated list in this option\nwill be reported. Wildcards and regular expressions are supported, multiple\nrecords must be separated by comma. Put the value into the double-quotes if\nit contains special characters like comma. All new line characters will be\nremoved in resulting configuration file, white spaces are removed from\nbeginning and end.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude_host_parents","full_name":"foreman_virt_who_configure_config[exclude_host_parents]","description":"\n\u003cp\u003eApplicable only for esx provider type. Hosts which parent (usually\nComputeResource) name is specified in comma-separated list in this option\nwill \u003cstrong\u003eNOT\u003c/strong\u003e be reported. Wildcards and regular expressions\nare supported, multiple records must be separated by comma. Put the value\ninto the double-quotes if it contains special characters like comma. All\nnew line characters will be removed in resulting configuration file, white\nspaces are removed from beginning and end.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_id","full_name":"foreman_virt_who_configure_config[hypervisor_id]","description":"\n\u003cp\u003eSpecifies how the hypervisor will be identified.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehostname\u003c/code\u003e, \u003ccode\u003euuid\u003c/code\u003e, \u003ccode\u003ehwuuid\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_type","full_name":"foreman_virt_who_configure_config[hypervisor_type]","description":"\n\u003cp\u003eHypervisor type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eesx\u003c/code\u003e, \u003ccode\u003erhevm\u003c/code\u003e, \u003ccode\u003ehyperv\u003c/code\u003e, \u003ccode\u003exen\u003c/code\u003e, \u003ccode\u003elibvirt\u003c/code\u003e, \u003ccode\u003ekubevirt\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_server","full_name":"foreman_virt_who_configure_config[hypervisor_server]","description":"\n\u003cp\u003eFully qualified host name or IP address of the hypervisor\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_username","full_name":"foreman_virt_who_configure_config[hypervisor_username]","description":"\n\u003cp\u003eAccount name by which virt-who is to connect to the hypervisor.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_password","full_name":"foreman_virt_who_configure_config[hypervisor_password]","description":"\n\u003cp\u003eHypervisor password, required for all hypervisor types except for libvirt\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"satellite_url","full_name":"foreman_virt_who_configure_config[satellite_url]","description":"\n\u003cp\u003eSatellite server FQDN\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"debug","full_name":"foreman_virt_who_configure_config[debug]","description":"\n\u003cp\u003eEnable debugging output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"proxy","full_name":"foreman_virt_who_configure_config[proxy]","description":"\n\u003cp\u003eHTTP proxy that should be used for communication between the server on\nwhich virt-who is running and the hypervisors and virtualization managers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"no_proxy","full_name":"foreman_virt_who_configure_config[no_proxy]","description":"\n\u003cp\u003eIgnore proxy. A comma-separated list of hostnames or domains or ip\naddresses to ignore proxy settings for. Optionally this may be set to * to\nbypass proxy settings for all hostnames domains or ip addresses.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"foreman_virt_who_configure_config[organization_id]","description":"\n\u003cp\u003eOrganization of the virt-who configuration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/configs/destroy","name":"destroy","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs/:id","http_method":"DELETE","short_description":"Delete a virt-who configuration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eConfiguration numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}},"link_extension":".html"}} \ No newline at end of file +{"docs":{"name":"Foreman","info":"\n\u003cp\u003eForeman API v2 is currently the default API version.\u003c/p\u003e\n","copyright":"","doc_url":"/apidoc/v2","api_url":"/api","resources":{"host_subscriptions":{"doc_url":"/apidoc/v2/host_subscriptions","id":"host_subscriptions","api_url":"/api","name":"Host_subscriptions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/host_subscriptions/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"GET","short_description":"List a host's subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_subscriptions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"DELETE","short_description":"Unregister the host as a subscription consumer","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_subscriptions/create","name":"create","apis":[{"api_url":"/api/hosts/subscriptions","http_method":"POST","short_description":"Register a host with subscription and information","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003eUUID to use for registered host, random uuid is generated if not provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003eKey-value hash of subscription-manager facts, nesting uses a period delimiter (.)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_guest_uuids","full_name":"hypervisor_guest_uuids","description":"\n\u003cp\u003eUUIDs of the virtual guests from the host\u0026#39;s hypervisor\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"installed_products","full_name":"installed_products","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"product_id","full_name":"installed_products[product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is not the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_name","full_name":"installed_products[product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"arch","full_name":"installed_products[arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"installed_products[version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003eRelease version of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eA service level for auto-healing process, e.g. SELF-SUPPORT\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lifecycle_environment_id","full_name":"lifecycle_environment_id","description":"\n\u003cp\u003eLifecycle Environment ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent View ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_subscriptions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/remove_subscriptions","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eIf specified, remove the first instance of a subscription with matching id and quantity\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_subscriptions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/add_subscriptions","http_method":"PUT","short_description":"Add a subscription to a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_subscriptions/product_content","name":"product_content","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/product_content","http_method":"GET","short_description":"Get content and overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the host\u0026#39;s content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_subscriptions/content_override","name":"content_override","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/content_override","http_method":"PUT","short_description":"Set content overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eOverride to a boolean value or \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"content_overrides_search","full_name":"content_overrides_search","description":"\n\u003cp\u003eContent override search parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"content_overrides_search[search]","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"content_overrides_search[page]","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"content_overrides_search[per_page]","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"content_overrides_search[order]","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"content_overrides_search[full_result]","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"content_overrides_search[sort_by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"content_overrides_search[sort_order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"content_overrides_search[enabled]","description":"\n\u003cp\u003eSet true to override to enabled; Set false to override to disabled.\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove","full_name":"content_overrides_search[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_subscriptions/available_release_versions","name":"available_release_versions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/available_release_versions","http_method":"GET","short_description":"Show releases available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_subscriptions/enabled_repositories","name":"enabled_repositories","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/enabled_repositories","http_method":"GET","short_description":"Show repositories enabled on the host that are known to Katello","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"interfaces":{"doc_url":"/apidoc/v2/interfaces","id":"interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/interfaces/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"GET","short_description":"List all interfaces for host","deprecated":null},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/interfaces/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"GET","short_description":"Show an interface for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/interfaces/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"POST","short_description":"Create an interface on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"execution","full_name":"interface[execution]","description":"\n\u003cp\u003eShould this interface be used for remote execution?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"execution","full_name":"interface[execution]","description":"\n\u003cp\u003eShould this interface be used for remote execution?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/interfaces/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"DELETE","short_description":"Delete a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hosts":{"doc_url":"/apidoc/v2/hosts","id":"hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"thin","full_name":"thin","description":"\n\u003cp\u003eOnly list ID and name of hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eparameters\u003c/code\u003e, \u003ccode\u003eall_parameters\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"activation_key","type":"string"},{"name":"activation_key_id","type":"string"},{"name":"addon","type":"string"},{"name":"addons_status","values":["mismatched","matched","not_specified"]},{"name":"applicable_debs","type":"string"},{"name":"applicable_errata","type":"string"},{"name":"applicable_errata_issued","type":"date"},{"name":"applicable_rpms","type":"string"},{"name":"architecture","type":"string"},{"name":"autoheal","type":"boolean"},{"name":"boot_time","type":""},{"name":"build","values":["true","false"]},{"name":"build_status","values":["built","pending","token_expired","build_failed"]},{"name":"comment","type":"text"},{"name":"compute_resource","type":"string"},{"name":"compute_resource_id","type":"integer"},{"name":"configuration_status.applied","type":"integer"},{"name":"configuration_status.enabled","values":["true","false"]},{"name":"configuration_status.failed","type":"integer"},{"name":"configuration_status.failed_restarts","type":"integer"},{"name":"configuration_status.interesting","values":["true","false"]},{"name":"configuration_status.pending","type":"integer"},{"name":"configuration_status.restarted","type":"integer"},{"name":"configuration_status.skipped","type":"integer"},{"name":"content_source","type":"string"},{"name":"content_views","type":"string"},{"name":"created_at","type":"datetime"},{"name":"cve_id","type":"integer"},{"name":"domain","type":"string"},{"name":"domain_id","type":"integer"},{"name":"errata_status","values":["security_needed","errata_needed","updated","unknown"]},{"name":"execution_status","values":["ok","error"]},{"name":"facts","type":"string"},{"name":"global_status","values":["ok","warning","error"]},{"name":"has_ip","type":"string"},{"name":"has_ip6","type":"string"},{"name":"has_mac","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_id","type":"integer"},{"name":"hostgroup_name","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"hypervisor","type":"boolean"},{"name":"hypervisor_host","type":"string"},{"name":"id","type":"integer"},{"name":"image","type":"string"},{"name":"infrastructure_facet.foreman","values":["true","false"]},{"name":"infrastructure_facet.smart_proxy_id","type":""},{"name":"insights_client_report_status","values":["reporting","no_report"]},{"name":"insights_inventory_sync_status","values":["disconnect","sync"]},{"name":"insights_recommendations_count","type":"integer"},{"name":"installable_errata","type":"string"},{"name":"installed_at","type":"datetime"},{"name":"ip","type":"string"},{"name":"ip6","type":"string"},{"name":"job_invocation.id","type":"string"},{"name":"job_invocation.result","values":["cancelled","failed","pending","success"]},{"name":"last_checkin","type":"datetime"},{"name":"last_report","type":"datetime"},{"name":"lifecycle_environments","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mac","type":"string"},{"name":"managed","values":["true","false"]},{"name":"model","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"owner","type":"string"},{"name":"owner_id","type":"integer"},{"name":"owner_type","type":"string"},{"name":"params","type":"string"},{"name":"params_name","type":"string"},{"name":"parent_hostgroup","type":"string"},{"name":"puppet_ca","type":"string"},{"name":"puppet_proxy_id","type":"integer"},{"name":"puppetmaster","type":"string"},{"name":"purpose_status","values":["mismatched","matched","not_specified"]},{"name":"pxe_loader","values":["PXELinux_BIOS","PXELinux_UEFI","Grub_UEFI","Grub2_BIOS","Grub2_ELF","Grub2_UEFI","Grub2_UEFI_SecureBoot","Grub2_UEFI_HTTP","Grub2_UEFI_HTTPS","Grub2_UEFI_HTTPS_SecureBoot","iPXE_Embedded","iPXE_UEFI_HTTP","iPXE_Chain_BIOS","iPXE_Chain_UEFI"]},{"name":"realm","type":"string"},{"name":"realm_id","type":"integer"},{"name":"registered_at","type":"datetime"},{"name":"registered_through","type":"string"},{"name":"release_version","type":"string"},{"name":"reported.bios_release_date","type":""},{"name":"reported.bios_vendor","type":""},{"name":"reported.bios_version","type":""},{"name":"reported.boot_time","type":""},{"name":"reported.cores","type":""},{"name":"reported.disks_total","type":""},{"name":"reported.kernel_version","type":""},{"name":"reported.ram","type":""},{"name":"reported.sockets","type":""},{"name":"reported.virtual","values":["true","false"]},{"name":"repository","type":"string"},{"name":"repository_content_label","type":"string"},{"name":"rhel_lifecycle_status","values":["full_support","maintenance_support","approaching_end_of_maintenance","extended_support","approaching_end_of_support","support_ended"]},{"name":"role","type":"text"},{"name":"role_status","values":["mismatched","matched","not_specified"]},{"name":"service_level","type":"string"},{"name":"sla_status","values":["mismatched","matched","not_specified"]},{"name":"smart_proxy","type":"string"},{"name":"status.applied","type":"integer"},{"name":"status.enabled","values":["true","false"]},{"name":"status.failed","type":"integer"},{"name":"status.failed_restarts","type":"integer"},{"name":"status.interesting","values":["true","false"]},{"name":"status.pending","type":"integer"},{"name":"status.restarted","type":"integer"},{"name":"status.skipped","type":"integer"},{"name":"subnet","type":"string"},{"name":"subnet.name","type":"text"},{"name":"subnet6","type":"string"},{"name":"subnet6.name","type":"text"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"subscription_status","values":["valid","partial","invalid","unknown","disabled","unsubscribed_hypervisor"]},{"name":"subscription_uuid","type":"string"},{"name":"trace_status","values":["reboot_needed","process_restart_needed","updated"]},{"name":"upgradable_debs","type":"string"},{"name":"upgradable_rpms","type":"string"},{"name":"usage","type":"text"},{"name":"usage_status","values":["mismatched","matched","not_specified"]},{"name":"user.firstname","type":"string"},{"name":"user.lastname","type":"string"},{"name":"user.login","type":"string"},{"name":"user.mail","type":"string"},{"name":"usergroup","type":"string"},{"name":"usergroup.name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/show","name":"show","apis":[{"api_url":"/api/hosts/:id","http_method":"GET","short_description":"Show a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"host[location_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a virtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"openscap_proxy_id","full_name":"host[openscap_proxy_id]","description":"\n\u003cp\u003eID of OpenSCAP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or default password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e, \u003ccode\u003ebootdisk\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"host[interfaces_attributes][id]","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is not the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]},{"name":"overwrite","full_name":"host[overwrite]","description":"\n\u003cp\u003eOverwrite existing host (true by default)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_role_ids","full_name":"host[ansible_role_ids]","description":"\n\u003cp\u003eIDs of associated ansible roles\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a virtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"openscap_proxy_id","full_name":"host[openscap_proxy_id]","description":"\n\u003cp\u003eID of OpenSCAP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or default password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e, \u003ccode\u003ebootdisk\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"host[interfaces_attributes][id]","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is not the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]},{"name":"ansible_role_ids","full_name":"host[ansible_role_ids]","description":"\n\u003cp\u003eIDs of associated ansible roles\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/enc","name":"enc","apis":[{"api_url":"/api/hosts/:id/enc","http_method":"GET","short_description":"Get ENC values of host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eglobal\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003econfiguration\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003ebuild\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eHostStatus::Global\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/forget_status","name":"forget_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"DELETE","short_description":"Clear sub-status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eClears a host sub-status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host\u0026#39;s compute attributes that can be used to create a clone of this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/power_status","name":"power_status","apis":[{"api_url":"/api/hosts/:id/power","http_method":"GET","short_description":"Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"timeout","full_name":"timeout","description":"\n\u003cp\u003eTimeout to retrieve the power status of the host in seconds. Default is 3 seconds.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/boot","name":"boot","apis":[{"api_url":"/api/hosts/:id/boot","http_method":"PUT","short_description":"Boot host from specified device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/facts","name":"facts","apis":[{"api_url":"/api/hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, Content_Host_Status, Refresh_Content_Host_Status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP, cloud-init, host_init_config, registration, kexec, Bootdisk\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/templates","name":"templates","apis":[{"api_url":"/api/hosts/:id/templates","http_method":"GET","short_description":"Get provisioning templates for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/inherited_parameters","name":"inherited_parameters","apis":[{"api_url":"/api/hosts/:id/inherited_parameters","http_method":"GET","short_description":"Get all inherited parameters for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/host_collections","name":"host_collections","apis":[{"api_url":"/api/hosts/:host_id/host_collections","http_method":"PUT","short_description":"Alter a host's host collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eThe id of the host to alter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/play_roles","name":"play_roles","apis":[{"api_url":"/api/hosts/:id/play_roles","http_method":"POST","short_description":"Runs all Ansible roles on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/multiple_play_roles","name":"multiple_play_roles","apis":[{"api_url":"/api/hosts/multiple_play_roles","http_method":"POST","short_description":"Runs all Ansible roles on hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eIDs of hosts to play roles on\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/ansible_roles","name":"ansible_roles","apis":[{"api_url":"/api/hosts/:id/ansible_roles","http_method":"GET","short_description":"List all Ansible roles for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/assign_ansible_roles","name":"assign_ansible_roles","apis":[{"api_url":"/api/hosts/:id/assign_ansible_roles","http_method":"POST","short_description":"Assigns Ansible roles to a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_role_ids","full_name":"ansible_role_ids","description":"\n\u003cp\u003eAnsible roles to assign to a host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/add_ansible_role","name":"add_ansible_role","apis":[{"api_url":"/api/hosts/:id/ansible_roles/:ansible_role_id","http_method":"PUT","short_description":"Directly add an Ansible role to a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_role_id","full_name":"ansible_role_id","description":"\n\u003cp\u003eAnsible role to add to a host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/remove_ansible_role","name":"remove_ansible_role","apis":[{"api_url":"/api/hosts/:id/ansible_roles/:ansible_role_id","http_method":"DELETE","short_description":"Remove directly assigned Ansible role from a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_role_id","full_name":"ansible_role_id","description":"\n\u003cp\u003eAnsible role to remove from a host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts/policies_enc","name":"policies_enc","apis":[{"api_url":"/api/hosts/:id/policies_enc","http_method":"GET","short_description":"Show config information for foreman_scap_client","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe identifier of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subnets":{"doc_url":"/apidoc/v2/subnets","id":"subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"boot_mode","type":"string"},{"name":"dns_primary","type":"string"},{"name":"dns_secondary","type":"string"},{"name":"domain","type":"string"},{"name":"gateway","type":"string"},{"name":"id","type":"integer"},{"name":"ipam","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mask","type":"string"},{"name":"mtu","type":"integer"},{"name":"name","type":"text"},{"name":"network","type":"string"},{"name":"nic_delay","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"string"},{"name":"type","type":"string"},{"name":"vlanid","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/subnets/show","name":"show","apis":[{"api_url":"/api/subnets/:id","http_method":"GET","short_description":"Show a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/subnets/create","name":"create","apis":[{"api_url":"/api/subnets","http_method":"POST","short_description":"Create a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"externalipam_group","full_name":"subnet[externalipam_group]","description":"\n\u003cp\u003eExternal IPAM group - only relevant when IPAM is set to external\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bmc_id","full_name":"subnet[bmc_id]","description":"\n\u003cp\u003eBMC Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discovery_id","full_name":"subnet[discovery_id]","description":"\n\u003cp\u003eID of Discovery Proxy to use within this subnet for managing connection to discovered hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remote_execution_proxy_ids","full_name":"subnet[remote_execution_proxy_ids]","description":"\n\u003cp\u003eList of proxy IDs to be used for remote execution\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"externalipam_group","full_name":"subnet[externalipam_group]","description":"\n\u003cp\u003eExternal IPAM group - only relevant when IPAM is set to external\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bmc_id","full_name":"subnet[bmc_id]","description":"\n\u003cp\u003eBMC Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discovery_id","full_name":"subnet[discovery_id]","description":"\n\u003cp\u003eID of Discovery Proxy to use within this subnet for managing connection to discovered hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remote_execution_proxy_ids","full_name":"subnet[remote_execution_proxy_ids]","description":"\n\u003cp\u003eList of proxy IDs to be used for remote execution\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/subnets/freeip","name":"freeip","apis":[{"api_url":"/api/subnets/:id/freeip","http_method":"GET","short_description":"Provides an unused IP address in this subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mac","full_name":"mac","description":"\n\u003cp\u003eMAC address to reuse the IP for this host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"excluded_ips","full_name":"excluded_ips","description":"\n\u003cp\u003eIP addresses that should be excluded from suggestion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"registration":{"doc_url":"/apidoc/v2/registration","id":"registration","api_url":"/api","name":"Registration","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/registration/global","name":"global","apis":[{"api_url":"/api/register","http_method":"GET","short_description":"Render Global registration template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the Organization to register the host in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of the Location to register the host in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of the Host group to register the host in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of the Operating System to register the host in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"setup_insights","full_name":"setup_insights","description":"\n\u003cp\u003eSet \u0026#39;host_registration_insights\u0026#39; parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"setup_remote_execution","full_name":"setup_remote_execution","description":"\n\u003cp\u003eSet \u0026#39;host_registration_remote_execution\u0026#39; parameter for the host. If it is set to true, SSH keys will be installed on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003ePackages to install on the host when registered. Can be set by `host_packages` parameter, example: `pkg1 pkg2`\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"update_packages","full_name":"update_packages","description":"\n\u003cp\u003eUpdate all packages on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repo","full_name":"repo","description":"\n\u003cp\u003eRepository URL / details, for example for Debian OS family: \u0026#39;deb \u003ca href=\"http://deb.example.com\"\u003edeb.example.com\u003c/a\u003e/ buster 1.0\u0026#39;, for Red Hat OS family: \u0026#39;\u003ca href=\"http://yum.theforeman.org/client/latest/el8/x86_64\"\u003eyum.theforeman.org/client/latest/el8/x86_64\u003c/a\u003e/\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repo_gpg_key_url","full_name":"repo_gpg_key_url","description":"\n\u003cp\u003eURL of the GPG key for the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remote_execution_interface","full_name":"remote_execution_interface","description":"\n\u003cp\u003eIdentifier of the Host interface for Remote execution\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"setup_remote_execution_pull","full_name":"setup_remote_execution_pull","description":"\n\u003cp\u003eSet \u0026#39;host_registration_remote_execution_pull\u0026#39; parameter for the host. If it is set to true, pull provider client will be deployed on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/registration/host","name":"host","apis":[{"api_url":"/api/register","http_method":"POST","short_description":"Find or create a host and render the 'Host initial configuration' template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003eIPv4 address, not required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip6","full_name":"host[ip6]","description":"\n\u003cp\u003eIPv6 address, not required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a virtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is not the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"setup_insights","full_name":"setup_insights","description":"\n\u003cp\u003eSet \u0026#39;host_registration_insights\u0026#39; parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"setup_remote_execution","full_name":"setup_remote_execution","description":"\n\u003cp\u003eSet \u0026#39;host_registration_remote_execution\u0026#39; parameter for the host. If it is set to true, SSH keys will be installed on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remote_execution_interface","full_name":"remote_execution_interface","description":"\n\u003cp\u003eIdentifier of the Host interface for Remote execution\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"setup_remote_execution_pull","full_name":"setup_remote_execution_pull","description":"\n\u003cp\u003eSet \u0026#39;host_registration_remote_execution_pull\u0026#39; parameter for the host. If it is set to true, pull provider client will be deployed on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"registration_commands":{"doc_url":"/apidoc/v2/registration_commands","id":"registration_commands","api_url":"/api","name":"Registration_commands","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/registration_commands/create","name":"create","apis":[{"api_url":"/api/registration_commands","http_method":"POST","short_description":"Generate global registration command","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"registration_command","full_name":"registration_command","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"organization_id","full_name":"registration_command[organization_id]","description":"\n\u003cp\u003eID of the Organization to register the host in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"registration_command[location_id]","description":"\n\u003cp\u003eID of the Location to register the host in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"registration_command[hostgroup_id]","description":"\n\u003cp\u003eID of the Host group to register the host in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"registration_command[operatingsystem_id]","description":"\n\u003cp\u003eID of the Operating System to register the host in. Operating system must have a `host_init_config` template assigned\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy_id","full_name":"registration_command[smart_proxy_id]","description":"\n\u003cp\u003eID of the Smart Proxy. This Proxy must have enabled both the \u0026#39;Templates\u0026#39; and \u0026#39;Registration\u0026#39; features\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"setup_insights","full_name":"registration_command[setup_insights]","description":"\n\u003cp\u003eSet \u0026#39;host_registration_insights\u0026#39; parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"setup_remote_execution","full_name":"registration_command[setup_remote_execution]","description":"\n\u003cp\u003eSet \u0026#39;host_registration_remote_execution\u0026#39; parameter for the host. If it is set to true, SSH keys will be installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"jwt_expiration","full_name":"registration_command[jwt_expiration]","description":"\n\u003cp\u003eExpiration of the authorization token (in hours)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"insecure","full_name":"registration_command[insecure]","description":"\n\u003cp\u003eEnable insecure argument for the initial curl\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"packages","full_name":"registration_command[packages]","description":"\n\u003cp\u003ePackages to install on the host when registered. Can be set by `host_packages` parameter, example: `pkg1 pkg2`\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"update_packages","full_name":"registration_command[update_packages]","description":"\n\u003cp\u003eUpdate all packages on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repo","full_name":"registration_command[repo]","description":"\n\u003cp\u003eRepository URL / details, for example for Debian OS family: \u0026#39;deb \u003ca href=\"http://deb.example.com\"\u003edeb.example.com\u003c/a\u003e/ buster 1.0\u0026#39;, for Red Hat and SUSE OS family: \u0026#39;\u003ca href=\"http://yum.theforeman.org/client/latest/el8/x86_64\"\u003eyum.theforeman.org/client/latest/el8/x86_64\u003c/a\u003e/\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repo_gpg_key_url","full_name":"registration_command[repo_gpg_key_url]","description":"\n\u003cp\u003eURL of the GPG key for the repository\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remote_execution_interface","full_name":"registration_command[remote_execution_interface]","description":"\n\u003cp\u003eIdentifier of the Host interface for Remote execution\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"setup_remote_execution_pull","full_name":"registration_command[setup_remote_execution_pull]","description":"\n\u003cp\u003eSet \u0026#39;host_registration_remote_execution_pull\u0026#39; parameter for the host. If it is set to true, pull provider client will be deployed on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"activation_key","full_name":"registration_command[activation_key]","description":"\n\u003cp\u003eActivation key for subscription-manager client, required for CentOS and Red Hat Enterprise Linux. For multiple keys use `activation_keys` param instead.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":true},{"name":"activation_keys","full_name":"registration_command[activation_keys]","description":"\n\u003cp\u003eActivation keys for subscription-manager client, required for CentOS and Red Hat Enterprise Linux. Required only if host group has no activation keys.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lifecycle_environment_id","full_name":"registration_command[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment for the host.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force","full_name":"registration_command[force]","description":"\n\u003cp\u003eClear any previous registration and run subscription-manager with –force.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ignore_subman_errors","full_name":"registration_command[ignore_subman_errors]","description":"\n\u003cp\u003eIgnore subscription-manager errors for `subscription-manager register` command\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hosts_bulk_actions":{"doc_url":"/apidoc/v2/hosts_bulk_actions","id":"hosts_bulk_actions","api_url":"/api","name":"Hosts_bulk_actions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/hosts_bulk_actions/bulk_destroy","name":"bulk_destroy","apis":[{"api_url":"/api/hosts/bulk","http_method":"DELETE","short_description":"Delete multiple hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"\n\u003cp\u003eHosts to include in the action\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string describing which hosts to perform the action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform the action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"\n\u003cp\u003eHosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not perform the action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/bulk_add_host_collections","name":"bulk_add_host_collections","apis":[{"api_url":"/api/hosts/bulk/add_host_collections","http_method":"PUT","short_description":"Add one or more host collections to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/bulk_remove_host_collections","name":"bulk_remove_host_collections","apis":[{"api_url":"/api/hosts/bulk/remove_host_collections","http_method":"PUT","short_description":"Remove one or more host collections from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/applicable_errata","name":"applicable_errata","apis":[{"api_url":"/api/hosts/bulk/applicable_errata","http_method":"POST","short_description":"Fetch applicable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/installable_errata","name":"installable_errata","apis":[{"api_url":"/api/hosts/bulk/installable_errata","http_method":"POST","short_description":"Fetch installable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/destroy_hosts","name":"destroy_hosts","apis":[{"api_url":"/api/hosts/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/bulk/remove_subscriptions","http_method":"PUT","short_description":"Remove subscriptions from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of specified subscription to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/bulk/add_subscriptions","http_method":"PUT","short_description":"Add subscriptions to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/bulk/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/content_overrides","name":"content_overrides","apis":[{"api_url":"/api/hosts/bulk/content_overrides","http_method":"PUT","short_description":"Set content overrides to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/environment_content_view","name":"environment_content_view","apis":[{"api_url":"/api/hosts/bulk/environment_content_view","http_method":"PUT","short_description":"Assign the environment and content view to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/release_version","name":"release_version","apis":[{"api_url":"/api/hosts/bulk/release_version","http_method":"PUT","short_description":"Assign the release version to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/traces","name":"traces","apis":[{"api_url":"/api/hosts/bulk/traces","http_method":"POST","short_description":"Fetch traces for one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/resolve_traces","name":"resolve_traces","apis":[{"api_url":"/api/hosts/bulk/resolve_traces","http_method":"PUT","short_description":"Resolve traces for one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"trace_ids","full_name":"trace_ids","description":"\n\u003cp\u003eArray of Trace IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/system_purpose","name":"system_purpose","apis":[{"api_url":"/api/hosts/bulk/system_purpose","http_method":"PUT","short_description":"Assign system purpose attributes on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eService level of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eRole of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eUsage of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/available_incremental_updates","name":"available_incremental_updates","apis":[{"api_url":"/api/hosts/bulk/available_incremental_updates","http_method":"POST","short_description":"Given a set of hosts and errata, lists the content view versions and environments that need updating.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/module_streams","name":"module_streams","apis":[{"api_url":"/api/hosts/bulk/module_streams","http_method":"POST","short_description":"Fetch available module streams for hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/change_content_source","name":"change_content_source","apis":[{"api_url":"/api/hosts/bulk/change_content_source","http_method":"PUT","short_description":"Update the content source for specified hosts and generate the reconfiguration script","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eThe ids of the hosts to alter. Hosts not managed by Katello are ignored\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eThe id of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eThe id of the content view\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_source_id","full_name":"content_source_id","description":"\n\u003cp\u003eThe id of the content source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"hostgroups":{"doc_url":"/apidoc/v2/hostgroups","id":"hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"parameters\"]","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"content_source","type":"string"},{"name":"content_view","type":"string"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"medium","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"oval_policy_id","type":"string"},{"name":"params","type":"string"},{"name":"template","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/show","name":"show","apis":[{"api_url":"/api/hostgroups/:id","http_method":"GET","short_description":"Show a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/create","name":"create","apis":[{"api_url":"/api/hostgroups","http_method":"POST","short_description":"Create a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"openscap_proxy_id","full_name":"hostgroup[openscap_proxy_id]","description":"\n\u003cp\u003eID of OpenSCAP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_role_ids","full_name":"hostgroup[ansible_role_ids]","description":"\n\u003cp\u003eIDs of associated ansible roles\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/update","name":"update","apis":[{"api_url":"/api/hostgroups/:id","http_method":"PUT","short_description":"Update a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"openscap_proxy_id","full_name":"hostgroup[openscap_proxy_id]","description":"\n\u003cp\u003eID of OpenSCAP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_role_ids","full_name":"hostgroup[ansible_role_ids]","description":"\n\u003cp\u003eIDs of associated ansible roles\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:id","http_method":"DELETE","short_description":"Delete a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/clone","name":"clone","apis":[{"api_url":"/api/hostgroups/:id/clone","http_method":"POST","short_description":"Clone a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hostgroups/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, Content_Host_Status, Refresh_Content_Host_Status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"children_hosts","full_name":"children_hosts","description":"\n\u003cp\u003eOperate on child hostgroup hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/play_roles","name":"play_roles","apis":[{"api_url":"/api/hostgroups/:id/play_roles","http_method":"POST","short_description":"Runs all Ansible roles on a hostgroup","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/multiple_play_roles","name":"multiple_play_roles","apis":[{"api_url":"/api/hostgroups/multiple_play_roles","http_method":"POST","short_description":"Runs all Ansible roles on hostgroups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_ids","full_name":"hostgroup_ids","description":"\n\u003cp\u003eIDs of hostgroups to play roles on\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/ansible_roles","name":"ansible_roles","apis":[{"api_url":"/api/hostgroups/:id/ansible_roles","http_method":"GET","short_description":"List all Ansible roles for a hostgroup","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/assign_ansible_roles","name":"assign_ansible_roles","apis":[{"api_url":"/api/hostgroups/:id/assign_ansible_roles","http_method":"POST","short_description":"Assigns Ansible roles to a hostgroup","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_role_ids","full_name":"ansible_role_ids","description":"\n\u003cp\u003eAnsible roles to assign to a hostgroup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/add_ansible_role","name":"add_ansible_role","apis":[{"api_url":"/api/hostgroups/:id/ansible_roles/:ansible_role_id","http_method":"PUT","short_description":"Directly add an Ansible role to a hostgroup","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_role_id","full_name":"ansible_role_id","description":"\n\u003cp\u003eAnsible role to add to a hostgroup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hostgroups/remove_ansible_role","name":"remove_ansible_role","apis":[{"api_url":"/api/hostgroups/:id/ansible_roles/:ansible_role_id","http_method":"DELETE","short_description":"Remove directly assigned Ansible role from a hostgroup","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_role_id","full_name":"ansible_role_id","description":"\n\u003cp\u003eAnsible role to remove from a hostgroup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxies":{"doc_url":"/apidoc/v2/smart_proxies","id":"smart_proxies","api_url":"/api","name":"Smart_proxies","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_status","full_name":"include_status","description":"\n\u003cp\u003eFlag to indicate whether to include status or not\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"feature","type":"string"},{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/smart_proxies/show","name":"show","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_status","full_name":"include_status","description":"\n\u003cp\u003eFlag to indicate whether to include status or not\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_version","full_name":"include_version","description":"\n\u003cp\u003eFlag to indicate whether to include version or not\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/smart_proxies/create","name":"create","apis":[{"api_url":"/api/smart_proxies","http_method":"POST","short_description":"Create a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of on_demand, immediate, inherit, streamed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy_id","full_name":"smart_proxy[http_proxy_id]","description":"\n\u003cp\u003eId of the HTTP proxy to use with alternate content sources\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/smart_proxies/update","name":"update","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"PUT","short_description":"Update a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of on_demand, immediate, inherit, streamed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy_id","full_name":"smart_proxy[http_proxy_id]","description":"\n\u003cp\u003eId of the HTTP proxy to use with alternate content sources\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/smart_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"DELETE","short_description":"Delete a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/smart_proxies/refresh","name":"refresh","apis":[{"api_url":"/api/smart_proxies/:id/refresh","http_method":"PUT","short_description":"Refresh smart proxy features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/smart_proxies/import_subnets","name":"import_subnets","apis":[{"api_url":"/api/smart_proxies/:id/import_subnets","http_method":"POST","short_description":"Import subnets from Smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_templates":{"doc_url":"/apidoc/v2/job_templates","id":"job_templates","api_url":"/api","name":"Job_templates","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/job_templates/index","name":"index","apis":[{"api_url":"/api/job_templates","http_method":"GET","short_description":"List job templates","deprecated":null},{"api_url":"/api/locations/:location_id/job_templates","http_method":"GET","short_description":"List job templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/job_templates","http_method":"GET","short_description":"List job templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_templates/import","name":"import","apis":[{"api_url":"/api/job_templates/import","http_method":"POST","short_description":"Import a job template from ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"template","description":"\n\u003cp\u003eTemplate ERB\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"overwrite","full_name":"overwrite","description":"\n\u003cp\u003eOverwrite template if it already exists\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_templates/export","name":"export","apis":[{"api_url":"/api/job_templates/:id/export","http_method":"GET","short_description":"Export a job template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_templates/show","name":"show","apis":[{"api_url":"/api/job_templates/:id","http_method":"GET","short_description":"Show job template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_templates/create","name":"create","apis":[{"api_url":"/api/job_templates","http_method":"POST","short_description":"Create a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"job_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e, \u003ccode\u003escript\u003c/code\u003e, \u003ccode\u003eAnsible\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the invocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_callback_enabled","full_name":"job_template[ansible_callback_enabled]","description":"\n\u003cp\u003eEnable the callback plugin for this template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_templates/update","name":"update","apis":[{"api_url":"/api/job_templates/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"job_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e, \u003ccode\u003escript\u003c/code\u003e, \u003ccode\u003eAnsible\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the invocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_callback_enabled","full_name":"job_template[ansible_callback_enabled]","description":"\n\u003cp\u003eEnable the callback plugin for this template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_templates/revision","name":"revision","apis":[{"api_url":"/api/job_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"version","description":"\n\u003cp\u003eTemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_templates/destroy","name":"destroy","apis":[{"api_url":"/api/job_templates/:id","http_method":"DELETE","short_description":"Delete a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_templates/clone","name":"clone","apis":[{"api_url":"/api/job_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_resources":{"doc_url":"/apidoc/v2/compute_resources","id":"compute_resources","api_url":"/api","name":"Compute_resources","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/compute_resources/index","name":"index","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/show","name":"show","apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/create","name":"create","apis":[{"api_url":"/api/compute_resources","http_method":"POST","short_description":"Create a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include Libvirt, Ovirt, EC2, Vmware, Openstack, AzureRm, GCE\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use \u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"app_ident","full_name":"compute_resource[app_ident]","description":"\n\u003cp\u003eClient ID for AzureRm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"secret_key","full_name":"compute_resource[secret_key]","description":"\n\u003cp\u003eClient Secret for AzureRm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sub_id","full_name":"compute_resource[sub_id]","description":"\n\u003cp\u003eSubscription ID for AzureRm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cloud","full_name":"compute_resource[cloud]","description":"\n\u003cp\u003eCloud\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path, for GCE only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003eZone, for GCE only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eDeprecated, project is automatically loaded from the JSON file. For GCE only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eDeprecated, email is automatically loaded from the JSON file. For GCE only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/update","name":"update","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include Libvirt, Ovirt, EC2, Vmware, Openstack, AzureRm, GCE\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use \u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"app_ident","full_name":"compute_resource[app_ident]","description":"\n\u003cp\u003eClient ID for AzureRm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"secret_key","full_name":"compute_resource[secret_key]","description":"\n\u003cp\u003eClient Secret for AzureRm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sub_id","full_name":"compute_resource[sub_id]","description":"\n\u003cp\u003eSubscription ID for AzureRm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cloud","full_name":"compute_resource[cloud]","description":"\n\u003cp\u003eCloud\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path, for GCE only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003eZone, for GCE only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eDeprecated, project is automatically loaded from the JSON file. For GCE only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eDeprecated, email is automatically loaded from the JSON file. For GCE only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_images","name":"available_images","apis":[{"api_url":"/api/compute_resources/:id/available_images","http_method":"GET","short_description":"List available images for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_clusters","name":"available_clusters","apis":[{"api_url":"/api/compute_resources/:id/available_clusters","http_method":"GET","short_description":"List available clusters for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_flavors","name":"available_flavors","apis":[{"api_url":"/api/compute_resources/:id/available_flavors","http_method":"GET","short_description":"List available flavors for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_folders","name":"available_folders","apis":[{"api_url":"/api/compute_resources/:id/available_folders","http_method":"GET","short_description":"List available folders for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_zones","name":"available_zones","apis":[{"api_url":"/api/compute_resources/:id/available_zones","http_method":"GET","short_description":"List available zone for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_networks","name":"available_networks","apis":[{"api_url":"/api/compute_resources/:id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_vnic_profiles","name":"available_vnic_profiles","apis":[{"api_url":"/api/compute_resources/:id/available_vnic_profiles","http_method":"GET","short_description":"List available vnic profiles for a compute resource, for oVirt only","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_resource_pools","name":"available_resource_pools","apis":[{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools","http_method":"GET","short_description":"List resource pools for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/storage_domain","name":"storage_domain","apis":[{"api_url":"/api/compute_resources/:id/storage_domains/:storage_domain_id","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"storage_domain_id","full_name":"storage_domain_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/storage_pod","name":"storage_pod","apis":[{"api_url":"/api/compute_resources/:id/storage_pods/:storage_pod_id","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"storage_pod_id","full_name":"storage_pod_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate/:vm_id","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vm_id","full_name":"vm_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/refresh_cache","name":"refresh_cache","apis":[{"api_url":"/api/compute_resources/:id/refresh_cache","http_method":"PUT","short_description":"Refresh Compute Resource Cache","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/available_virtual_machines","name":"available_virtual_machines","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines","http_method":"GET","short_description":"List available virtual machines for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/show_vm","name":"show_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"GET","short_description":"Show a virtual machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/power_vm","name":"power_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id/power","http_method":"PUT","short_description":"Power a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_resources/destroy_vm","name":"destroy_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"DELETE","short_description":"Delete a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"fact_values":{"doc_url":"/apidoc/v2/fact_values","id":"fact_values","api_url":"/api","name":"Fact_values","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/fact_values/index","name":"index","apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fact","type":"string"},{"name":"fact_short_name","type":"string"},{"name":"facts","type":"string"},{"name":"host","type":"string"},{"name":"host.hostgroup","type":"string"},{"name":"host_id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"reported_at","type":"datetime"},{"name":"short_name","type":"string"},{"name":"type","type":"string"},{"name":"value","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"recurring_logics":{"doc_url":"/apidoc/v2/recurring_logics","id":"recurring_logics","api_url":"/api","name":"Recurring_logics","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/recurring_logics/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/recurring_logics","http_method":"GET","short_description":"List recurring logics","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/recurring_logics/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"GET","short_description":"Show recurring logic details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/recurring_logics/update","name":"update","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"PUT","short_description":"Update recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eWhether the recurring logic is enabled or disabled.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/recurring_logics/cancel","name":"cancel","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id/cancel","http_method":"POST","short_description":"Cancel recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/recurring_logics/bulk_destroy","name":"bulk_destroy","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/bulk_destroy","http_method":"POST","short_description":"Delete recurring logics by search query","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch query\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreman_tasks":{"doc_url":"/apidoc/v2/foreman_tasks","id":"foreman_tasks","api_url":"/api","name":"Foreman_tasks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/foreman_tasks/summary","name":"summary","apis":[{"api_url":"/foreman_tasks/api/tasks/summary","http_method":"GET","short_description":"Show task summary","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreman_tasks/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/tasks/:id","http_method":"GET","short_description":"Show task details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreman_tasks/details","name":"details","apis":[{"api_url":"/foreman_tasks/api/tasks/:id/details","http_method":"GET","short_description":"Show task extended details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreman_tasks/bulk_search","name":"bulk_search","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_search","http_method":"POST","short_description":"List dynflow tasks for uuids","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eFor every search it returns the list of tasks that satisfty the condition. The reason for supporting multiple searches is the UI that might be ending needing periodic updates on task status for various searches at the same time. This way, it is possible to get all the task statuses with one request.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"searches","full_name":"searches","description":"\n\u003cp\u003eList of uuids to fetch info about\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search_id","full_name":"searches[search_id]","description":"\n\u003cp\u003eArbitraty value for client to identify the the request parts with results. It\u0026#39;s passed in the results to be able to pair the requests and responses properly.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"searches[type]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003eresource\u003c/code\u003e, \u003ccode\u003etask\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"task_id","full_name":"searches[task_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;task\u0026#39;, find the task by the uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"searches[user_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;user\u0026#39;, find tasks for the user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource type we\u0026#39;re searching the tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource id we\u0026#39;re searching the tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_types","full_name":"searches[action_types]","description":"\n\u003cp\u003eReturn just tasks of given action type, e.g. `[“Actions::Katello::Repository::Synchronize”]`\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eString\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"active_only","full_name":"searches[active_only]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"searches[page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"searches[per_page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreman_tasks/bulk_resume","name":"bulk_resume","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_resume","http_method":"POST","short_description":"Resume all paused error tasks","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eResumes all selected resumable tasks. If neither a search query nor an explicit list of task IDs is provided, it tries to resume all tasks in paused state with result error.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eResume tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eResume specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreman_tasks/bulk_cancel","name":"bulk_cancel","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_cancel","http_method":"POST","short_description":"Cancel selected cancellable tasks","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCancels all selected cancellable tasks. Requires a search query or an explicit list of task IDs to be provided.\u003c/p\u003e\n","errors":[{"code":400,"description":"Returned if neither search nor task_ids parameter is provided.","metadata":null}],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eCancel tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eCancel specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreman_tasks/bulk_stop","name":"bulk_stop","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_stop","http_method":"POST","short_description":"Stop selected stoppable tasks","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eStops all selected tasks which are not already stopped. Requires a search query or an explicit list of task IDs to be provided.\u003c/p\u003e\n","errors":[{"code":400,"description":"Returned if neither search nor task_ids parameter is provided.","metadata":null}],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eStop tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eStop specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreman_tasks/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/tasks","http_method":"GET","short_description":"List tasks","deprecated":null},{"api_url":"/foreman_tasks/api/tasks/:parent_task_id/sub_tasks","http_method":"GET","short_description":"Show sub_tasks details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_task_id","full_name":"parent_task_id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreman_tasks/callback","name":"callback","apis":[{"api_url":"/foreman_tasks/api/tasks/callback","http_method":"POST","short_description":"Send data to the task from external executor (such as smart_proxy_dynflow)","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback","full_name":"callback","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"task_id","full_name":"callback[task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"step_id","full_name":"callback[step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"data","full_name":"data","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callbacks","full_name":"callbacks","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"callback","full_name":"callbacks[callback]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"task_id","full_name":"callbacks[callback][task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"step_id","full_name":"callbacks[callback][step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"data","full_name":"callbacks[data]","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreign_input_sets":{"doc_url":"/apidoc/v2/foreign_input_sets","id":"foreign_input_sets","api_url":"/api","name":"Foreign_input_sets","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/foreign_input_sets/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"GET","short_description":"List foreign input sets","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreign_input_sets/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"GET","short_description":"Show foreign input set details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreign_input_sets/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"POST","short_description":"Create a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign template.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign template.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreign_input_sets/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"DELETE","short_description":"Delete a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/foreign_input_sets/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"PUT","short_description":"Update a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign template.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign template.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_invocations":{"doc_url":"/apidoc/v2/job_invocations","id":"job_invocations","api_url":"/api","name":"Job_invocations","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/job_invocations/index","name":"index","apis":[{"api_url":"/api/job_invocations","http_method":"GET","short_description":"List job invocations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_invocations/show","name":"show","apis":[{"api_url":"/api/job_invocations/:id","http_method":"GET","short_description":"Show job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_status","full_name":"host_status","description":"\n\u003cp\u003eShow Job status for the hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_invocations/create","name":"create","apis":[{"api_url":"/api/job_invocations","http_method":"POST","short_description":"Create a job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"job_invocation","full_name":"job_invocation","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"job_template_id","full_name":"job_invocation[job_template_id]","description":"\n\u003cp\u003eThe job template to use, parameter is required unless feature was specified\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"targeting_type","full_name":"job_invocation[targeting_type]","description":"\n\u003cp\u003eInvocation type, one of {“static_query”=\u0026gt;“Static Query”, “dynamic_query”=\u0026gt;“Dynamic Query”}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"randomized_ordering","full_name":"job_invocation[randomized_ordering]","description":"\n\u003cp\u003eExecute the jobs on hosts in randomized order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inputs","full_name":"job_invocation[inputs]","description":"\n\u003cp\u003eInputs to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssh","full_name":"job_invocation[ssh]","description":"\n\u003cp\u003eSSH provider specific options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"effective_user","full_name":"job_invocation[ssh][effective_user]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"effective_user_password","full_name":"job_invocation[ssh][effective_user_password]","description":"\n\u003cp\u003eSet password for effective user (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"ssh_user","full_name":"job_invocation[ssh_user]","description":"\n\u003cp\u003eSet SSH user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"job_invocation[password]","description":"\n\u003cp\u003eSet SSH password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_passphrase","full_name":"job_invocation[key_passphrase]","description":"\n\u003cp\u003eSet SSH key passphrase\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"recurrence","full_name":"job_invocation[recurrence]","description":"\n\u003cp\u003eCreate a recurring job\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"cron_line","full_name":"job_invocation[recurrence][cron_line]","description":"\n\u003cp\u003eHow often the job should occur, in the cron format\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_iteration","full_name":"job_invocation[recurrence][max_iteration]","description":"\n\u003cp\u003eRepeat a maximum of N times\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"job_invocation[recurrence][end_time]","description":"\n\u003cp\u003ePerform no more executions after this time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose","full_name":"job_invocation[recurrence][purpose]","description":"\n\u003cp\u003eDesignation of a special purpose\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"scheduling","full_name":"job_invocation[scheduling]","description":"\n\u003cp\u003eSchedule the job to start at a later time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start_at","full_name":"job_invocation[scheduling][start_at]","description":"\n\u003cp\u003eSchedule the job for a future time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_before","full_name":"job_invocation[scheduling][start_before]","description":"\n\u003cp\u003eIndicates that the action should be cancelled if it cannot be started before this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"concurrency_control","full_name":"job_invocation[concurrency_control]","description":"\n\u003cp\u003eControl concurrency level and distribution over time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"concurrency_level","full_name":"job_invocation[concurrency_control][concurrency_level]","description":"\n\u003cp\u003eRun at most N tasks at a time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"bookmark_id","full_name":"job_invocation[bookmark_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search_query","full_name":"job_invocation[search_query]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description_format","full_name":"job_invocation[description_format]","description":"\n\u003cp\u003eOverride the description format from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"execution_timeout_interval","full_name":"job_invocation[execution_timeout_interval]","description":"\n\u003cp\u003eOverride the timeout interval from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"feature","full_name":"job_invocation[feature]","description":"\n\u003cp\u003eRemote execution feature label that should be triggered, job template assigned to this feature will be used\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_to_pickup","full_name":"job_invocation[time_to_pickup]","description":"\n\u003cp\u003eOverride the global time to pickup interval for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible","full_name":"job_invocation[ansible]","description":"\n\u003cp\u003eAnsible provider specific inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"tags","full_name":"job_invocation[ansible][tags]","description":"\n\u003cp\u003eA comma separated list of tags to use for Ansible run\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags_flag","full_name":"job_invocation[ansible][tags_flag]","description":"\n\u003cp\u003eIncludeExclude tags for Ansible run\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einclude\u003c/code\u003e, \u003ccode\u003eexclude\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_invocations/output","name":"output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id","http_method":"GET","short_description":"Get output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"since","full_name":"since","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_invocations/raw_output","name":"raw_output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id/raw","http_method":"GET","short_description":"Get raw output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_invocations/cancel","name":"cancel","apis":[{"api_url":"/api/job_invocations/:id/cancel","http_method":"POST","short_description":"Cancel job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force","full_name":"force","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_invocations/rerun","name":"rerun","apis":[{"api_url":"/api/job_invocations/:id/rerun","http_method":"POST","short_description":"Rerun job on failed hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"failed_only","full_name":"failed_only","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/job_invocations/outputs","name":"outputs","apis":[{"api_url":"/api/job_invocations/:id/outputs","http_method":"GET","short_description":"Get outputs of hosts in a job","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search_query","full_name":"search_query","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"since","full_name":"since","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"raw","full_name":"raw","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"remote_execution_features":{"doc_url":"/apidoc/v2/remote_execution_features","id":"remote_execution_features","api_url":"/api","name":"Remote_execution_features","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/remote_execution_features/index","name":"index","apis":[{"api_url":"/api/remote_execution_features","http_method":"GET","short_description":"List remote execution features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/remote_execution_features/show","name":"show","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"GET","short_description":"Show remote execution feature","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/remote_execution_features/update","name":"update","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remote_execution_feature","full_name":"remote_execution_feature","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"job_template_id","full_name":"remote_execution_feature[job_template_id]","description":"\n\u003cp\u003eJob template ID to be used for the feature\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/remote_execution_features/available_remote_execution_features","name":"available_remote_execution_features","apis":[{"api_url":"/api/api/hosts/:id/available_remote_execution_features","http_method":"GET","short_description":"List available remote execution features for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_invocations":{"doc_url":"/apidoc/v2/template_invocations","id":"template_invocations","api_url":"/api","name":"Template_invocations","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/template_invocations/template_invocations","name":"template_invocations","apis":[{"api_url":"/api/job_invocations/:job_invocation_id/template_invocations","http_method":"GET","short_description":"List template invocations belonging to job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"job_invocation_id","full_name":"job_invocation_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"candlepin_dynflow_proxy":{"doc_url":"/apidoc/v2/candlepin_dynflow_proxy","id":"candlepin_dynflow_proxy","api_url":"/api","name":"Candlepin_dynflow_proxy","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/candlepin_dynflow_proxy/upload_profiles","name":"upload_profiles","apis":[{"api_url":"/katello/api/consumers/:id/profiles","http_method":"PUT","short_description":"Update installed packages, enabled repos, module inventory","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the consumer\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"candlepin_proxies":{"doc_url":"/apidoc/v2/candlepin_proxies","id":"candlepin_proxies","api_url":"/api","name":"Candlepin_proxies","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/candlepin_proxies/upload_tracer_profile","name":"upload_tracer_profile","apis":[{"api_url":"/katello/api/consumers/:id/tracer","http_method":"PUT","short_description":"Update services requiring restart","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"traces","full_name":"traces","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/candlepin_proxies/enabled_repos","name":"enabled_repos","apis":[{"api_url":"/katello/api/systems/:id/enabled_repos","http_method":"PUT","short_description":"Update the information about enabled repositories","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUsed to keep the information about enabled repositories up to date. This information is then used for computing the errata available for the system.\u003c/p\u003e\n","errors":[],"params":[{"name":"enabled_repos","full_name":"enabled_repos","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"repos","full_name":"enabled_repos[repos]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"baseurl","full_name":"enabled_repos[repos][baseurl]","description":"\n\u003cp\u003eList of enabled repo urls for the repo (Only first is used.)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the system\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"activation_keys":{"doc_url":"/apidoc/v2/activation_keys","id":"activation_keys","api_url":"/api","name":"Activation_keys","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/activation_keys/index","name":"index","apis":[{"api_url":"/katello/api/activation_keys","http_method":"GET","short_description":"List activation keys","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eactivation key name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"addon","type":"string"},{"name":"content_view","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"environment","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"usage","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/create","name":"create","apis":[{"api_url":"/katello/api/activation_keys","http_method":"POST","short_description":"Create an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment","full_name":"environment","description":"\n\u003cp\u003eenvironment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/update","name":"update","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"PUT","short_description":"Update an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"DELETE","short_description":"Destroy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/show","name":"show","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"GET","short_description":"Show an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_hosts","full_name":"show_hosts","description":"\n\u003cp\u003eShow hosts associated to an activation key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/copy","name":"copy","apis":[{"api_url":"/katello/api/activation_keys/:id/copy","http_method":"POST","short_description":"Copy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003eName of new activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/available_host_collections","name":"available_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections/available","http_method":"GET","short_description":"List host collections the activation key does not belong to","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/available_releases","name":"available_releases","apis":[{"api_url":"/katello/api/activation_keys/:id/releases","http_method":"GET","short_description":"Show release versions available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/add_host_collections","name":"add_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to associate with activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/remove_host_collections","name":"remove_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to disassociate from the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/add_subscriptions","http_method":"PUT","short_description":"Attach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eQuantity of this subscription to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/remove_subscriptions","http_method":"PUT","short_description":"Unattach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/content_override","name":"content_override","apis":[{"api_url":"/katello/api/activation_keys/:id/content_override","http_method":"PUT","short_description":"Override content for activation_key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters to be added in bulk\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride parameter key or name. Note if name is not provided the default name will be \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/activation_keys/product_content","name":"product_content","apis":[{"api_url":"/katello/api/activation_keys/:id/product_content","http_method":"GET","short_description":"Show content available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the activation key\u0026#39;s content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"alternate_content_sources_bulk_actions":{"doc_url":"/apidoc/v2/alternate_content_sources_bulk_actions","id":"alternate_content_sources_bulk_actions","api_url":"/api","name":"Alternate_content_sources_bulk_actions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/alternate_content_sources_bulk_actions/destroy_alternate_content_sources","name":"destroy_alternate_content_sources","apis":[{"api_url":"/katello/api/alternate_content_sources/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more alternate content sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of alternate content source IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/alternate_content_sources_bulk_actions/refresh_alternate_content_sources","name":"refresh_alternate_content_sources","apis":[{"api_url":"/katello/api/alternate_content_sources/bulk/refresh","http_method":"POST","short_description":"Refresh alternate content sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of alternate content source IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/alternate_content_sources_bulk_actions/refresh_all_alternate_content_sources","name":"refresh_all_alternate_content_sources","apis":[{"api_url":"/katello/api/alternate_content_sources/bulk/refresh_all","http_method":"POST","short_description":"Refresh all alternate content sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"alternate_content_sources":{"doc_url":"/apidoc/v2/alternate_content_sources","id":"alternate_content_sources","api_url":"/api","name":"Alternate_content_sources","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/alternate_content_sources/index","name":"index","apis":[{"api_url":"/katello/api/alternate_content_sources","http_method":"GET","short_description":"List alternate content sources.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the alternate content source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"alternate_content_source_type","type":"string"},{"name":"base_url","type":"string"},{"name":"content_type","type":"string"},{"name":"description","type":"text"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"},{"name":"smart_proxy_id","type":"integer"},{"name":"smart_proxy_name","type":"string"},{"name":"subpath","type":"string"},{"name":"upstream_username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/alternate_content_sources/show","name":"show","apis":[{"api_url":"/katello/api/alternate_content_sources/:id","http_method":"GET","short_description":"Show an alternate content source.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAlternate content source ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/alternate_content_sources/create","name":"create","apis":[{"api_url":"/katello/api/alternate_content_sources","http_method":"POST","short_description":"Create an alternate content source to download content from during repository syncing. Note: alternate content sources are global and affect ALL sync actions on their smart proxies regardless of organization.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe content type for the Alternate Content Source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003eyum\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"alternate_content_source_type","full_name":"alternate_content_source_type","description":"\n\u003cp\u003eThe Alternate Content Source type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecustom\u003c/code\u003e, \u003ccode\u003esimplified\u003c/code\u003e, \u003ccode\u003erhui\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the alternate content source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the alternate content source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"base_url","full_name":"base_url","description":"\n\u003cp\u003eBase URL for finding alternate content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subpaths","full_name":"subpaths","description":"\n\u003cp\u003ePath suffixes for finding alternate content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy_ids","full_name":"smart_proxy_ids","description":"\n\u003cp\u003eIds of smart proxies to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy_names","full_name":"smart_proxy_names","description":"\n\u003cp\u003eNames of smart proxies to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eBasic authentication username\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003eBasic authentication password\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"verify_ssl","full_name":"verify_ssl","description":"\n\u003cp\u003eIf SSL should be verified for the upstream URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_http_proxies","full_name":"use_http_proxies","description":"\n\u003cp\u003eIf the smart proxies\u0026#39; assigned HTTP proxies should be used\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eIDs of products to copy repository information from into a Simplified Alternate Content Source. Products must include at least one repository of the chosen content type.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/alternate_content_sources/update","name":"update","apis":[{"api_url":"/katello/api/alternate_content_sources/:id","http_method":"PUT","short_description":"Update an alternate content source.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the alternate content source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the alternate content source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"base_url","full_name":"base_url","description":"\n\u003cp\u003eBase URL for finding alternate content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subpaths","full_name":"subpaths","description":"\n\u003cp\u003ePath suffixes for finding alternate content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy_ids","full_name":"smart_proxy_ids","description":"\n\u003cp\u003eIds of smart proxies to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy_names","full_name":"smart_proxy_names","description":"\n\u003cp\u003eNames of smart proxies to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eBasic authentication username\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003eBasic authentication password\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"verify_ssl","full_name":"verify_ssl","description":"\n\u003cp\u003eIf SSL should be verified for the upstream URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_http_proxies","full_name":"use_http_proxies","description":"\n\u003cp\u003eIf the smart proxies\u0026#39; assigned HTTP proxies should be used\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eIDs of products to copy repository information from into a Simplified Alternate Content Source. Products must include at least one repository of the chosen content type.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAlternate content source ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/alternate_content_sources/destroy","name":"destroy","apis":[{"api_url":"/katello/api/alternate_content_sources/:id","http_method":"DELETE","short_description":"Destroy an alternate content source.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAlternate content source ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/alternate_content_sources/refresh","name":"refresh","apis":[{"api_url":"/katello/api/alternate_content_sources/:id/refresh","http_method":"POST","short_description":"Refresh an alternate content source. Refreshing, like repository syncing, is required before using an alternate content source.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAlternate content source ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ansible_collections":{"doc_url":"/apidoc/v2/ansible_collections","id":"ansible_collections","api_url":"/api","name":"Ansible Collections","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/ansible_collections/index","name":"index","apis":[{"api_url":"/katello/api/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_filter_ids","full_name":"include_filter_ids","description":"\n\u003cp\u003eIncludes associated content view filter ids in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_collections/show","name":"show","apis":[{"api_url":"/katello/api/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean ansible collection identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_collections/compare","name":"compare","apis":[{"api_url":"/katello/api/ansible_collections/compare","http_method":"GET","short_description":"List :resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"capsule_content":{"doc_url":"/apidoc/v2/capsule_content","id":"capsule_content","api_url":"/api","name":"Capsule_content","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/capsule_content/counts","name":"counts","apis":[{"api_url":"/katello/api/capsules/:id/content/counts","http_method":"GET","short_description":"List content counts for the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/capsule_content/update_counts","name":"update_counts","apis":[{"api_url":"/katello/api/capsules/:id/content/update_counts","http_method":"POST","short_description":"Update content counts for the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/capsule_content/lifecycle_environments","name":"lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/capsule_content/available_lifecycle_environments","name":"available_lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/available_lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments not attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/capsule_content/add_lifecycle_environment","name":"add_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"POST","short_description":"Add lifecycle environments to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/capsule_content/remove_lifecycle_environment","name":"remove_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments/:environment_id","http_method":"DELETE","short_description":"Remove lifecycle environments from the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/capsule_content/sync","name":"sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"POST","short_description":"Synchronize the content to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the environment to limit the synchronization on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eId of the content view to limit the synchronization on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eId of the repository to limit the synchronization on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eSkip metadata check on each repository on the smart proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/capsule_content/sync_status","name":"sync_status","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"GET","short_description":"Get current smart proxy synchronization status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to get the status for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/capsule_content/cancel_sync","name":"cancel_sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"DELETE","short_description":"Cancel running smart proxy synchronization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/capsule_content/reclaim_space","name":"reclaim_space","apis":[{"api_url":"/katello/api/capsules/:id/content/reclaim_space","http_method":"POST","short_description":"Reclaim space from all On Demand repositories on a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"capsules":{"doc_url":"/apidoc/v2/capsules","id":"capsules","api_url":"/api","name":"Capsules","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/capsules/index","name":"index","apis":[{"api_url":"/katello/api/capsules","http_method":"GET","short_description":"List all smart proxies that have content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/capsules/show","name":"show","apis":[{"api_url":"/katello/api/capsules/:id","http_method":"GET","short_description":"Show the smart proxy details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_credentials":{"doc_url":"/apidoc/v2/content_credentials","id":"content_credentials","api_url":"/api","name":"Content_credentials","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eContent Credentials are used to store credentials like GPG Keys and Certificates for the authentication to Products / Repositories.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_credentials/index","name":"index","apis":[{"api_url":"/katello/api/content_credentials","http_method":"GET","short_description":"List Content Credentials","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the Content Credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eType of content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_credentials/create","name":"create","apis":[{"api_url":"/katello/api/content_credentials","http_method":"POST","short_description":"Create a Content Credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the Content Credential\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eType of content: “cert”, “gpg_key”\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"\n\u003cp\u003ePublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_credentials/show","name":"show","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"GET","short_description":"Show a Content Credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_credentials/update","name":"update","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"PUT","short_description":"Update a Content Credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Credential ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the Content Credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eType of content: “cert”, “gpg_key”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"\n\u003cp\u003ePublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_credentials/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"DELETE","short_description":"Destroy a Content Credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Credential ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_credentials/content","name":"content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"GET","short_description":"Return the content of a Content Credential, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_credentials/set_content","name":"set_content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"POST","short_description":"Upload Content Credential contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Credential ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"\n\u003cp\u003eFile contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_export_incrementals":{"doc_url":"/apidoc/v2/content_export_incrementals","id":"content_export_incrementals","api_url":"/api","name":"Content_export_incrementals","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_export_incrementals/version","name":"version","apis":[{"api_url":"/katello/api/content_export_incrementals/version","http_method":"POST","short_description":"Performs an incremental-export of a content view version.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fail_on_missing_content","full_name":"fail_on_missing_content","description":"\n\u003cp\u003eFails if any of the repositories belonging to this version are unexportable. False by default.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"destination_server","full_name":"destination_server","description":"\n\u003cp\u003eDestination Server name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chunk_size_gb","full_name":"chunk_size_gb","description":"\n\u003cp\u003eSplit the exported content into archives no greater than the specified size in gigabytes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"format","full_name":"format","description":"\n\u003cp\u003eExport formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker repositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003esyncable\u003c/code\u003e, \u003ccode\u003eimportable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"from_history_id","full_name":"from_history_id","description":"\n\u003cp\u003eExport history identifier used for incremental export. If not provided the most recent export history will be used.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_export_incrementals/library","name":"library","apis":[{"api_url":"/katello/api/content_export_incrementals/library","http_method":"POST","short_description":"Performs an incremental-export of the repositories in library.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fail_on_missing_content","full_name":"fail_on_missing_content","description":"\n\u003cp\u003eFails if any of the repositories belonging to this organization are unexportable. False by default.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"destination_server","full_name":"destination_server","description":"\n\u003cp\u003eDestination Server name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chunk_size_gb","full_name":"chunk_size_gb","description":"\n\u003cp\u003eSplit the exported content into archives no greater than the specified size in gigabytes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"format","full_name":"format","description":"\n\u003cp\u003eExport formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker repositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003esyncable\u003c/code\u003e, \u003ccode\u003eimportable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"from_history_id","full_name":"from_history_id","description":"\n\u003cp\u003eExport history identifier used for incremental export. If not provided the most recent export history will be used.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_export_incrementals/repository","name":"repository","apis":[{"api_url":"/katello/api/content_export_incrementals/repository","http_method":"POST","short_description":"Performs a incremental-export of the repository in library.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chunk_size_gb","full_name":"chunk_size_gb","description":"\n\u003cp\u003eSplit the exported content into archives no greater than the specified size in gigabytes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"format","full_name":"format","description":"\n\u003cp\u003eExport formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker repositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003esyncable\u003c/code\u003e, \u003ccode\u003eimportable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"from_history_id","full_name":"from_history_id","description":"\n\u003cp\u003eExport history identifier used for incremental export. If not provided the most recent export history will be used.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_exports":{"doc_url":"/apidoc/v2/content_exports","id":"content_exports","api_url":"/api","name":"Content_exports","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_exports/index","name":"index","apis":[{"api_url":"/katello/api/content_exports","http_method":"GET","short_description":"List export histories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"destination_server","full_name":"destination_server","description":"\n\u003cp\u003eDestination Server name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version export history identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n\u003cp\u003eExport Types\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecomplete\u003c/code\u003e, \u003ccode\u003eincremental\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"content_view_version_id","type":"integer"},{"name":"id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_exports/version","name":"version","apis":[{"api_url":"/katello/api/content_exports/version","http_method":"POST","short_description":"Performs a full-export of a content view version.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fail_on_missing_content","full_name":"fail_on_missing_content","description":"\n\u003cp\u003eFails if any of the repositories belonging to this version are unexportable. False by default.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"destination_server","full_name":"destination_server","description":"\n\u003cp\u003eDestination Server name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chunk_size_gb","full_name":"chunk_size_gb","description":"\n\u003cp\u003eSplit the exported content into archives no greater than the specified size in gigabytes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"format","full_name":"format","description":"\n\u003cp\u003eExport formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker repositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003esyncable\u003c/code\u003e, \u003ccode\u003eimportable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_exports/library","name":"library","apis":[{"api_url":"/katello/api/content_exports/library","http_method":"POST","short_description":"Performs a full-export of the repositories in library.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fail_on_missing_content","full_name":"fail_on_missing_content","description":"\n\u003cp\u003eFails if any of the repositories belonging to this organization are unexportable. False by default.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"destination_server","full_name":"destination_server","description":"\n\u003cp\u003eDestination Server name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chunk_size_gb","full_name":"chunk_size_gb","description":"\n\u003cp\u003eSplit the exported content into archives no greater than the specified size in gigabytes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"format","full_name":"format","description":"\n\u003cp\u003eExport formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker repositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003esyncable\u003c/code\u003e, \u003ccode\u003eimportable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_exports/repository","name":"repository","apis":[{"api_url":"/katello/api/content_exports/repository","http_method":"POST","short_description":"Performs a full-export of the repository in library.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"chunk_size_gb","full_name":"chunk_size_gb","description":"\n\u003cp\u003eSplit the exported content into archives no greater than the specified size in gigabytes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"format","full_name":"format","description":"\n\u003cp\u003eExport formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker repositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003esyncable\u003c/code\u003e, \u003ccode\u003eimportable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_imports":{"doc_url":"/apidoc/v2/content_imports","id":"content_imports","api_url":"/api","name":"Content_imports","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_imports/index","name":"index","apis":[{"api_url":"/katello/api/content_imports","http_method":"GET","short_description":"List import histories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version import history identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n\u003cp\u003eImport Types\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecomplete\u003c/code\u003e, \u003ccode\u003eincremental\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"content_view_version_id","type":"integer"},{"name":"id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_imports/version","name":"version","apis":[{"api_url":"/katello/api/content_imports/version","http_method":"POST","short_description":"Import a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"path","full_name":"path","description":"\n\u003cp\u003eDirectory containing the exported Content View Version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"metadata","full_name":"metadata","description":"\n\u003cp\u003eMetadata taken from the upstream export history for this Content View Version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_imports/library","name":"library","apis":[{"api_url":"/katello/api/content_imports/library","http_method":"POST","short_description":"Import a content view version to the library","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"path","full_name":"path","description":"\n\u003cp\u003eDirectory containing the exported Content View Version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"metadata","full_name":"metadata","description":"\n\u003cp\u003eMetadata taken from the upstream export history for this Content View Version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_imports/repository","name":"repository","apis":[{"api_url":"/katello/api/content_imports/repository","http_method":"POST","short_description":"Import a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"path","full_name":"path","description":"\n\u003cp\u003eDirectory containing the exported Content View Version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"metadata","full_name":"metadata","description":"\n\u003cp\u003eMetadata taken from the upstream export history for this Content View Version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_uploads":{"doc_url":"/apidoc/v2/content_uploads","id":"content_uploads","api_url":"/api","name":"Content_uploads","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_uploads/create","name":"create","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads","http_method":"POST","short_description":"Create an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"checksum","full_name":"checksum","description":"\n\u003cp\u003eChecksum of file to upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;, \u0026#39;ostree_ref\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003eostree_ref\u003c/code\u003e, \u003ccode\u003epython_package\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_uploads/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"PUT","short_description":"Upload a chunk of the file's content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eThe offset in the file where the content starts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"\n\u003cp\u003eThe actual file contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_uploads/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"DELETE","short_description":"Delete an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_components":{"doc_url":"/apidoc/v2/content_view_components","id":"content_view_components","api_url":"/api","name":"Content_view_components","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_view_components/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components","http_method":"GET","short_description":"List components attached to this content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_components/add_components","name":"add_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/add","http_method":"PUT","short_description":"Add components to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"components","full_name":"components","description":"\n\u003cp\u003eArray of components to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"content_view_version_id","full_name":"components[content_view_version_id]","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"components[content_view_id]","description":"\n\u003cp\u003econtent view identifier of the component who\u0026#39;s latest version is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"latest","full_name":"components[latest]","description":"\n\u003cp\u003etrue if the latest version of the component\u0026#39;s content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_components/remove_components","name":"remove_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/remove","http_method":"PUT","short_description":"Remove components from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eArray of content view component IDs to remove. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_components/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"GET","short_description":"Show a content view component","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_components/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"PUT","short_description":"Update a component associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"latest","full_name":"latest","description":"\n\u003cp\u003etrue if the latest version of the components content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_filter_rules":{"doc_url":"/apidoc/v2/content_view_filter_rules","id":"content_view_filter_rules","api_url":"/api","name":"Content_view_filter_rules","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_view_filter_rules/index","name":"index","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"GET","short_description":"List filter rules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerrata_id of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_filter_rules/create","name":"create","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"POST","short_description":"Create a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003edeb, package, package group, or docker tag names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [String]","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003epackage group: uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eerratum: IDs or a select all object\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_type","full_name":"date_type","description":"\n\u003cp\u003eerratum: search using the \u0026#39;Issued On\u0026#39; or \u0026#39;Updated On\u0026#39; column of the errata. Values are \u0026#39;issued\u0026#39;/\u0026#39;updated\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"module_stream_ids","full_name":"module_stream_ids","description":"\n\u003cp\u003emodule stream ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_filter_rules/show","name":"show","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"GET","short_description":"Show filter rule info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_filter_rules/update","name":"update","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"PUT","short_description":"Update a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage, package group, or docker tag: name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_filter_rules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"DELETE","short_description":"Delete a filter rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_filters":{"doc_url":"/apidoc/v2/content_view_filters","id":"content_view_filters","api_url":"/api","name":"Content_view_filters","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_view_filters/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"get","short_description":"list filters","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"get","short_description":"list filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter content view filters by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"types","full_name":"types","description":"\n\u003cp\u003etypes of filters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_type","values":["rpm","deb","package_group","erratum","docker","modulemd"]},{"name":"inclusion_type","values":["include","exclude"]},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_filters/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the filter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n\u003cp\u003etype of filter (e.g. deb, rpm, package_group, erratum, erratum_id, erratum_date, docker, modulemd)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list. (module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default: inclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_filters/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"get","short_description":"show filter info","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"get","short_description":"show filter info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_filters/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"put","short_description":"update a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"put","short_description":"update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003enew name for the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list. (module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default: inclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_filters/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_filters/remove_filter_rules","name":"remove_filter_rules","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id/remove_filter_rules","http_method":"put","short_description":"bulk delete filter rules","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id/remove_filter_rules","http_method":"put","short_description":"bulk delete filter rules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rule_ids","full_name":"rule_ids","description":"\n\u003cp\u003efilter identifiers\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of number","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_filters/add_filter_rules","name":"add_filter_rules","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id/add_filter_rules","http_method":"put","short_description":"bulk add filter rules","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id/add_filter_rules","http_method":"put","short_description":"bulk add filter rules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rules_params","full_name":"rules_params","description":"\n\u003cp\u003eRules to be added\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"rules_params[name]","description":"\n\u003cp\u003epackage, package group, or docker tag names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [String]","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"rules_params[uuid]","description":"\n\u003cp\u003epackage group: uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"rules_params[version]","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture","full_name":"rules_params[architecture]","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"min_version","full_name":"rules_params[min_version]","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_version","full_name":"rules_params[max_version]","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"errata_id","full_name":"rules_params[errata_id]","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"errata_ids","full_name":"rules_params[errata_ids]","description":"\n\u003cp\u003eerratum: IDs or a select all object\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"rules_params[start_date]","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"rules_params[end_date]","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"types","full_name":"rules_params[types]","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_type","full_name":"rules_params[date_type]","description":"\n\u003cp\u003eerratum: search using the \u0026#39;Issued On\u0026#39; or \u0026#39;Updated On\u0026#39; column of the errata. Values are \u0026#39;issued\u0026#39;/\u0026#39;updated\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"module_stream_ids","full_name":"rules_params[module_stream_ids]","description":"\n\u003cp\u003emodule stream ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_histories":{"doc_url":"/apidoc/v2/content_view_histories","id":"content_view_histories","api_url":"/api","name":"Content_view_histories","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_view_histories/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:id/history","http_method":"GET","short_description":"Show a content view's history","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_versions":{"doc_url":"/apidoc/v2/content_view_versions","id":"content_view_versions","api_url":"/api","name":"Content_view_versions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_view_versions/index","name":"index","apis":[{"api_url":"/katello/api/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eFilter versions by environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"version","description":"\n\u003cp\u003eFilter versions by version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"composite_version_id","full_name":"composite_version_id","description":"\n\u003cp\u003eFilter versions that are components in the specified composite version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_applied_filters","full_name":"include_applied_filters","description":"\n\u003cp\u003eWhether or not to return filters applied to the content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"triggered_by_id","full_name":"triggered_by_id","description":"\n\u003cp\u003eFilter composite versions whose publish was triggered by the specified component version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_id","full_name":"file_id","description":"\n\u003cp\u003eFilter content view versions that contain the file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"nondefault","full_name":"nondefault","description":"\n\u003cp\u003eFilter out default content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"repository","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_versions/show","name":"show","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"GET","short_description":"Show content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_applied_filters","full_name":"include_applied_filters","description":"\n\u003cp\u003eWhether or not to return filters applied to the content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_versions/promote","name":"promote","apis":[{"api_url":"/katello/api/content_view_versions/:id/promote","http_method":"POST","short_description":"Promote a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force","full_name":"force","description":"\n\u003cp\u003eforce content view promotion and bypass lifecycle environment restriction\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eIdentifiers for Lifecycle Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version promotion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_versions/update","name":"update","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"PUT","short_description":"Update a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_versions/republish_repositories","name":"republish_repositories","apis":[{"api_url":"/katello/api/content_view_versions/:id/republish_repositories","http_method":"PUT","short_description":"Forces a republish of the version's repositories' metadata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force","full_name":"force","description":"\n\u003cp\u003eForce metadata regeneration to proceed. Dangerous operation when version has repositories with the \u0026#39;Complete Mirroring\u0026#39; mirroring policy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_versions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"DELETE","short_description":"Remove content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_view_versions/incremental_update","name":"incremental_update","apis":[{"api_url":"/katello/api/content_view_versions/incremental_update","http_method":"POST","short_description":"Perform an Incremental Update on one or more Content View Versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_environments","full_name":"content_view_version_environments","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"content_view_version_id","full_name":"content_view_version_environments[content_view_version_id]","description":"\n\u003cp\u003eContent View Version Ids to perform an incremental update on. May contain composites as well as one or more components to update.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_ids","full_name":"content_view_version_environments[environment_ids]","description":"\n\u003cp\u003eThe list of environments to promote the specified Content View Version to (replacing the older version)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the new generated Content View Versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"resolve_dependencies","full_name":"resolve_dependencies","description":"\n\u003cp\u003eIf true, when adding the specified errata or packages, any needed dependencies will be copied as well. Defaults to true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"propagate_all_composites","full_name":"propagate_all_composites","description":"\n\u003cp\u003eIf true, will publish a new composite version using any specified content_view_version_id that has been promoted to a lifecycle environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_content","full_name":"add_content","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"errata_ids","full_name":"add_content[errata_ids]","description":"\n\u003cp\u003eErrata ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"package_ids","full_name":"add_content[package_ids]","description":"\n\u003cp\u003ePackage ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deb_ids","full_name":"add_content[deb_ids]","description":"\n\u003cp\u003eDeb Package ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"update_hosts","full_name":"update_hosts","description":"\n\u003cp\u003eAfter generating the incremental update, apply the changes to the specified hosts. Only Errata are supported currently.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"included","full_name":"update_hosts[included]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"update_hosts[included][search]","description":"\n\u003cp\u003eSearch string for host to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"update_hosts[included][ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"update_hosts[excluded]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"update_hosts[excluded][ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_views":{"doc_url":"/apidoc/v2/content_views","id":"content_views","api_url":"/api","name":"Content_views","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_views/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"GET","short_description":"List content views","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"GET","short_description":"List content views","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"nondefault","full_name":"nondefault","description":"\n\u003cp\u003eFilter out default content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"noncomposite","full_name":"noncomposite","description":"\n\u003cp\u003eFilter out composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eFilter only composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"without","full_name":"without","description":"\n\u003cp\u003eDo not include this array of content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"label","description":"\n\u003cp\u003eLabel of the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_generated","full_name":"include_generated","description":"\n\u003cp\u003eInclude content views generated by imports/exports. Defaults to false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"composite","type":"boolean"},{"name":"content_views","type":"string"},{"name":"default","type":"boolean"},{"name":"generated_for","type":"integer"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_views/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"label","description":"\n\u003cp\u003eContent view label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eComposite content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_only","full_name":"import_only","description":"\n\u003cp\u003eDesignate this Content View for importing from upstream servers only. Defaults to false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_views/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"PUT","short_description":"Update a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew name for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_only","full_name":"import_only","description":"\n\u003cp\u003eDesignate this Content View for importing from upstream servers only. Defaults to false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_views/publish","name":"publish","apis":[{"api_url":"/katello/api/content_views/:id/publish","http_method":"POST","short_description":"Publish a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the new published content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"major","full_name":"major","description":"\n\u003cp\u003eOverride the major version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"minor","full_name":"minor","description":"\n\u003cp\u003eOverride the minor version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eIdentifiers for Lifecycle Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"publish_only_if_needed","full_name":"publish_only_if_needed","description":"\n\u003cp\u003eCheck audited changes and proceed only if content or filters have changed since last publish\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_force_promote","full_name":"is_force_promote","description":"\n\u003cp\u003eForce content view promotion and bypass lifecycle environment restriction\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repos_units","full_name":"repos_units","description":"\n\u003cp\u003eSpecify the list of units in each repo\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"label","full_name":"repos_units[label]","description":"\n\u003cp\u003erepo label\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rpm_filenames","full_name":"repos_units[rpm_filenames]","description":"\n\u003cp\u003elist of rpm filename strings to include in published version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_views/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"GET","short_description":"Show a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_views/remove_from_environment","name":"remove_from_environment","apis":[{"api_url":"/katello/api/content_views/:id/environments/:environment_id","http_method":"DELETE","short_description":"Remove a content view from an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_views/remove","name":"remove","apis":[{"api_url":"/katello/api/content_views/:id/remove","http_method":"PUT","short_description":"Remove versions and/or environments from a content view and reassign systems and keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eenvironment numeric identifiers to be removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of number","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view version identifiers to be deleted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of number","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"system_content_view_id","full_name":"system_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"system_environment_id","full_name":"system_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_content_view_id","full_name":"key_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_environment_id","full_name":"key_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"destroy_content_view","full_name":"destroy_content_view","description":"\n\u003cp\u003edelete the content view with all the versions and environments\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_views/bulk_delete_versions","name":"bulk_delete_versions","apis":[{"api_url":"/katello/api/content_views/:id/bulk_delete_versions","http_method":"PUT","short_description":"Bulk remove versions from a content view and reassign systems and keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"included","full_name":"included","description":"\n\u003cp\u003eVersions to exclusively include in the action\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for versions to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of versions to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"excluded","full_name":"excluded","description":"\n\u003cp\u003eVersions to explicitly exclude in the action. All other versions will be included in the action, unless an included parameter is passed as well.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of versions to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"system_content_view_id","full_name":"system_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"system_environment_id","full_name":"system_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_content_view_id","full_name":"key_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_environment_id","full_name":"key_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_views/remove_filters","name":"remove_filters","apis":[{"api_url":"/katello/api/content_views/:id/remove_filters","http_method":"PUT","short_description":"Delete multiple filters from a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_ids","full_name":"filter_ids","description":"\n\u003cp\u003efilter identifiers\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of number","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_views/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"DELETE","short_description":"Delete a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/content_views/copy","name":"copy","apis":[{"api_url":"/katello/api/content_views/:id/copy","http_method":"POST","short_description":"Make copy of a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew content view name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"debs":{"doc_url":"/apidoc/v2/debs","id":"debs","api_url":"/api","name":"Deb Packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/debs/index","name":"index","apis":[{"api_url":"/katello/api/debs","http_method":"GET","short_description":"List deb packages","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/debs","http_method":"GET","short_description":"List deb packages","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/debs","http_method":"GET","short_description":"List deb packages","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs","http_method":"GET","short_description":"List deb packages","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eDeb package identifiers to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable deb packages for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"packages_restrict_applicable","full_name":"packages_restrict_applicable","description":"\n\u003cp\u003eReturn deb packages that are applicable to one or more hosts (defaults to true if host_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"packages_restrict_upgradable","full_name":"packages_restrict_upgradable","description":"\n\u003cp\u003eReturn deb packages that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"packages_restrict_latest","full_name":"packages_restrict_latest","description":"\n\u003cp\u003eReturn only the latest version of each package\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn deb packages that can be added to the specified object. Only the value \u0026#39;content_view_version\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/debs/show","name":"show","apis":[{"api_url":"/katello/api/debs/:id","http_method":"GET","short_description":"Show a deb package","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs/:id","http_method":"GET","short_description":"Show a deb package","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea deb package identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/debs/compare","name":"compare","apis":[{"api_url":"/katello/api/debs/compare","http_method":"GET","short_description":"List deb packages","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"docker_manifest_lists":{"doc_url":"/apidoc/v2/docker_manifest_lists","id":"docker_manifest_lists","api_url":"/api","name":"Docker_manifest_lists","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/docker_manifest_lists/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_filter_ids","full_name":"include_filter_ids","description":"\n\u003cp\u003eIncludes associated content view filter ids in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/docker_manifest_lists/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest list identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/docker_manifest_lists/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifest_lists/compare","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_manifests":{"doc_url":"/apidoc/v2/docker_manifests","id":"docker_manifests","api_url":"/api","name":"Docker_manifests","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/docker_manifests/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_filter_ids","full_name":"include_filter_ids","description":"\n\u003cp\u003eIncludes associated content view filter ids in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/docker_manifests/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/docker_manifests/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifests/compare","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_tags":{"doc_url":"/apidoc/v2/docker_tags","id":"docker_tags","api_url":"/api","name":"Docker_tags","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/docker_tags/index","name":"index","apis":[{"api_url":"/katello/api/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_filter_ids","full_name":"include_filter_ids","description":"\n\u003cp\u003eIncludes associated content view filter ids in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/docker_tags/show","name":"show","apis":[{"api_url":"/katello/api/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker tag identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/docker_tags/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_tags/compare","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/docker_tags/repositories","name":"repositories","apis":[{"api_url":"/katello/api/docker_tags/:id/repositories","http_method":"GET","short_description":"List of repositories for a docker meta tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"lifecycle_environments":{"doc_url":"/apidoc/v2/lifecycle_environments","id":"lifecycle_environments","api_url":"/api","name":"Lifecycle_environments","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eAn environment is a basic organization structure that groups hosts, products, repositories, etc. Every host belongs to one environment and it\u0026#39;s isolated inside so that it can see only content that is in its environment.\u003c/p\u003e\n\n\u003cp\u003e## Chains\u003c/p\u003e\n\n\u003cp\u003eEnvironments are ordered into chains and their content (products, repositories, tempaltes, packages) can be moved to an environment only from its prior environment. You can have for example chain like:\u003c/p\u003e\n\n\u003cpre\u003eLibrary -\u0026gt; Development -\u0026gt; Testing -\u0026gt; Production\u003c/pre\u003e\n\n\u003cp\u003eEach change in an environment is done through a changeset in an action called promotion.\u003c/p\u003e\n\n\u003cp\u003e## Library\u003c/p\u003e\n\n\u003cp\u003eLibrary is a special environment that has no ascendant: All the content starts in this environment. More chains can start from the library environment but no further branching of a chain is enabled.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/lifecycle_environments/index","name":"index","apis":[{"api_url":"/katello/api/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"library","full_name":"library","description":"\n\u003cp\u003eset true if you want to see only library environments\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter only environments containing this name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"label","description":"\n\u003cp\u003efilter only environments containing this label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/lifecycle_environments/show","name":"show","apis":[{"api_url":"/katello/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/lifecycle_environments/create","name":"create","apis":[{"api_url":"/katello/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"POST","short_description":"Create an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prior_id","full_name":"prior_id","description":"\n\u003cp\u003eID of an environment that is prior to the new environment in the chain. It has to be either the ID of Library or the ID of an environment at the end of a chain.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/lifecycle_environments/update","name":"update","apis":[{"api_url":"/katello/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"PUT","short_description":"Update an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003enew name to be given to the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the update action to finish. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/lifecycle_environments/destroy","name":"destroy","apis":[{"api_url":"/katello/api/environments/:id","http_method":"DELETE","short_description":"Destroy an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"DELETE","short_description":"Destroy an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/lifecycle_environments/paths","name":"paths","apis":[{"api_url":"/katello/api/organizations/:organization_id/environments/paths","http_method":"GET","short_description":"List environment paths","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_source_id","full_name":"content_source_id","description":"\n\u003cp\u003eShow whether each lifecycle environment is associated with the given Smart Proxy id.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"permission_type","full_name":"permission_type","description":"\n\u003cp\u003eThe associated permission type. One of (readable | promotable) Default: readable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"errata":{"doc_url":"/apidoc/v2/errata","id":"errata","api_url":"/api","name":"Errata","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/errata/index","name":"index","apis":[{"api_url":"/katello/api/errata","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable errata for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to one or more hosts (defaults to true if host_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eReturn errata that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn errata that can be added to the specified object. The values \u0026#39;content_view_version\u0026#39; and \u0026#39;content_view_filter are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"bug","type":"string"},{"name":"cve","type":"string"},{"name":"db_id","type":"integer"},{"name":"errata_id","type":"string"},{"name":"errata_type","type":"string"},{"name":"id","type":"string"},{"name":"issued","type":"date"},{"name":"modular","values":["true","false"]},{"name":"package","type":"string"},{"name":"package_name","type":"string"},{"name":"reboot_suggested","type":"boolean"},{"name":"repository","type":"string"},{"name":"severity","type":"string"},{"name":"synopsis","type":"string"},{"name":"title","type":"string"},{"name":"type","type":"string"},{"name":"updated","type":"date"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/errata/show","name":"show","apis":[{"api_url":"/katello/api/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean erratum identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/errata/compare","name":"compare","apis":[{"api_url":"/katello/api/errata/compare","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"file_units":{"doc_url":"/apidoc/v2/file_units","id":"file_units","api_url":"/api","name":"Files","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/file_units/index","name":"index","apis":[{"api_url":"/katello/api/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files","http_method":"GET","short_description":"List files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_filter_ids","full_name":"include_filter_ids","description":"\n\u003cp\u003eIncludes associated content view filter ids in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/file_units/show","name":"show","apis":[{"api_url":"/katello/api/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea file identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/file_units/compare","name":"compare","apis":[{"api_url":"/katello/api/files/compare","http_method":"GET","short_description":"List :resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"generic_content_units":{"doc_url":"/apidoc/v2/generic_content_units","id":"generic_content_units","api_url":"/api","name":"Content Units","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/generic_content_units/index","name":"index","apis":[{"api_url":"/katello/api/content_units","http_method":"GET","short_description":"List content_units","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/content_units","http_method":"GET","short_description":"List content_units","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/content_units","http_method":"GET","short_description":"List content_units","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/content_units","http_method":"GET","short_description":"List content_units","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003ePossible values: ostree_ref, python_package\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_filter_ids","full_name":"include_filter_ids","description":"\n\u003cp\u003eIncludes associated content view filter ids in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/generic_content_units/show","name":"show","apis":[{"api_url":"/katello/api/content_units/:id","http_method":"GET","short_description":"Show a content unit","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/content_units/:id","http_method":"GET","short_description":"Show a content unit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003ePossible values: ostree_ref, python_package\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea content unit identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/generic_content_units/compare","name":"compare","apis":[{"api_url":"/katello/api/content_units/compare","http_method":"GET","short_description":"List :resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003ePossible values: ostree_ref, python_package\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/generic_content_units/default_sort","name":"default_sort","apis":[{"api_url":"/katello/api/ostree_refs","http_method":"GET","short_description":"List ostree_refs","deprecated":null},{"api_url":"/katello/api/ostree_refs/:id","http_method":"GET","short_description":"Show ostree ref","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ostree_refs/:id","http_method":"GET","short_description":"Show ostree ref","deprecated":null},{"api_url":"/katello/api/python_packages","http_method":"GET","short_description":"List python_packages","deprecated":null},{"api_url":"/katello/api/python_packages/:id","http_method":"GET","short_description":"Show python package","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/python_packages/:id","http_method":"GET","short_description":"Show python package","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003ePossible values: ostree_ref, python_package\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_collections":{"doc_url":"/apidoc/v2/host_collections","id":"host_collections","api_url":"/api","name":"Host_collections","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/host_collections/show","name":"show","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"GET","short_description":"Show a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_collections/index","name":"index","apis":[{"api_url":"/katello/api/host_collections","http_method":"GET","short_description":"List host collections","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"GET","short_description":"List host collections within an organization","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/host_collections","http_method":"GET","short_description":"List host collections in an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eactivation key identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eFilter products by host id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Host Collections that can be associated with specified object. The value \u0026#39;host\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"host","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_collections/create","name":"create","apis":[{"api_url":"/katello/api/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_collections/update","name":"update","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"PUT","short_description":"Update a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_collections/add_hosts","name":"add_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/add_hosts","http_method":"PUT","short_description":"Add host to the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_collections/remove_hosts","name":"remove_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/remove_hosts","http_method":"PUT","short_description":"Remove hosts from the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_collections/destroy","name":"destroy","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"DELETE","short_description":"Destroy a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_collections/copy","name":"copy","apis":[{"api_url":"/katello/api/host_collections/:id/copy","http_method":"POST","short_description":"Make copy of a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew host collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_debs":{"doc_url":"/apidoc/v2/host_debs","id":"host_debs","api_url":"/api","name":"Host_debs","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/host_debs/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/debs","http_method":"GET","short_description":"List deb packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_errata":{"doc_url":"/apidoc/v2/host_errata","id":"host_errata","api_url":"/api","name":"Host_errata","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/host_errata/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/errata","http_method":"GET","short_description":"List errata available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Content View\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_applicable","full_name":"include_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to this host. Defaults to false)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n\u003cp\u003eReturn only errata of a particular type (security, bugfix, enhancement)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"severity","full_name":"severity","description":"\n\u003cp\u003eReturn only errata of a particular severity (None, Low, Moderate, Important, Critical)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_errata/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/errata/:id","http_method":"GET","short_description":"Retrieve a single errata for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eErrata id of the erratum (RHSA-2012:108)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_errata/applicability","name":"applicability","apis":[{"api_url":"/api/hosts/:host_id/errata/applicability","http_method":"PUT","short_description":"Force regenerate applicability.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_module_streams":{"doc_url":"/apidoc/v2/host_module_streams","id":"host_module_streams","api_url":"/api","name":"Host_module_streams","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/host_module_streams/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/module_streams","http_method":"GET","short_description":"List module streams available to the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eStreams based on the host based on their status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eenabled\u003c/code\u003e, \u003ccode\u003edisabled\u003c/code\u003e, \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003einstalled\u003c/code\u003e, \u003ccode\u003eupgradable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"install_status","full_name":"install_status","description":"\n\u003cp\u003eStreams based on the host based on the installation status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_packages":{"doc_url":"/apidoc/v2/host_packages","id":"host_packages","api_url":"/api","name":"Host_packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/host_packages/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/packages","http_method":"GET","short_description":"List packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_latest_upgradable","full_name":"include_latest_upgradable","description":"\n\u003cp\u003eAlso include the latest upgradable package version for each host package\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eReturn only packages of a particular status (upgradable or up-to-date)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"arch","type":"string"},{"name":"epoch","type":"string"},{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"nvra","type":"string"},{"name":"nvrea","type":"string"},{"name":"release","type":"string"},{"name":"vendor","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_tracer":{"doc_url":"/apidoc/v2/host_tracer","id":"host_tracer","api_url":"/api","name":"Host_tracer","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/host_tracer/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/traces","http_method":"GET","short_description":"List services that need restarting on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_tracer/resolve","name":"resolve","apis":[{"api_url":"/api/hosts/:host_id/traces/resolve","http_method":"PUT","short_description":"Resolve traces","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trace_ids","full_name":"trace_ids","description":"\n\u003cp\u003eArray of Trace IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ping":{"doc_url":"/apidoc/v2/ping","id":"ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/ping/index","name":"index","apis":[{"api_url":"/katello/api/ping","http_method":"GET","short_description":"Shows status of Katello system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ping/server_status","name":"server_status","apis":[{"api_url":"/katello/api/status","http_method":"GET","short_description":"Shows version information","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ping/ping","name":"ping","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ping/statuses","name":"statuses","apis":[{"api_url":"/api/statuses","http_method":"GET","short_description":"Shows status and version information of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"module_streams":{"doc_url":"/apidoc/v2/module_streams","id":"module_streams","api_url":"/api","name":"Module_streams","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/module_streams/index","name":"index","apis":[{"api_url":"/katello/api/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_filter_ids","full_name":"include_filter_ids","description":"\n\u003cp\u003eIncludes associated content view filter ids in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host id to list available module streams for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name_stream_only","full_name":"name_stream_only","description":"\n\u003cp\u003eReturn name and stream information only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/module_streams/show","name":"show","apis":[{"api_url":"/katello/api/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea module stream identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/module_streams/compare","name":"compare","apis":[{"api_url":"/katello/api/module_streams/compare","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"organizations":{"doc_url":"/apidoc/v2/organizations","id":"organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/katello/api/organizations","http_method":"GET","short_description":"List all organizations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"GET","short_description":"Show organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/katello/api/organizations","http_method":"POST","short_description":"Create organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ignore_types","full_name":"organization[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"simple_content_access","full_name":"simple_content_access","description":"\n\u003cp\u003eWhether to turn on Simple Content Access for the organization.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":true}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"PUT","short_description":"Update organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"redhat_repository_url","full_name":"redhat_repository_url","description":"\n\u003cp\u003eRed Hat CDN URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":true},{"name":"simple_content_access","full_name":"simple_content_access","description":"\n\u003cp\u003eWhether Simple Content Access should be enabled for the organization.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":true},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ignore_types","full_name":"organization[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/organizations/repo_discover","name":"repo_discover","apis":[{"api_url":"/katello/api/organizations/:id/repo_discover","http_method":"PUT","short_description":"Discover Repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"url","description":"\n\u003cp\u003eBase URL to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eOne of yum or docker\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch pattern (defaults to \u0026#39;*\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/organizations/cancel_repo_discover","name":"cancel_repo_discover","apis":[{"api_url":"/katello/api/organizations/:label/cancel_repo_discover","http_method":"PUT","short_description":"Cancel repository discovery","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"url","description":"\n\u003cp\u003ebase url to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/organizations/download_debug_certificate","name":"download_debug_certificate","apis":[{"api_url":"/katello/api/organizations/:label/download_debug_certificate","http_method":"GET","short_description":"Download a debug certificate","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/organizations/releases","name":"releases","apis":[{"api_url":"/katello/api/organizations/:id/releases","http_method":"GET","short_description":"List available releases in the organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the Organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/organizations/cdn_configuration","name":"cdn_configuration","apis":[{"api_url":"/katello/api/organizations/:id/cdn_configuration","http_method":"PUT","short_description":"Update the CDN configuration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the Organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n\u003cp\u003eCDN configuration type. One of redhat_cdn, network_sync, export_sync, custom_cdn.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"url","description":"\n\u003cp\u003eUpstream foreman server to sync CDN content from. Relevant only for \u0026#39;upstream_server\u0026#39; type.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"username","description":"\n\u003cp\u003eUsername for authentication. Relevant only for \u0026#39;upstream_server\u0026#39; type.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n\u003cp\u003ePassword for authentication. Relevant only for \u0026#39;upstream_server\u0026#39; type.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_organization_label","full_name":"upstream_organization_label","description":"\n\u003cp\u003eUpstream organization to sync CDN content from. Relevant only for \u0026#39;upstream_server\u0026#39; type.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_content_view_label","full_name":"upstream_content_view_label","description":"\n\u003cp\u003eUpstream Content View Label, default: Default_Organization_View. Relevant only for \u0026#39;upstream_server\u0026#39; type.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_lifecycle_environment_label","full_name":"upstream_lifecycle_environment_label","description":"\n\u003cp\u003eUpstream Lifecycle Environment, default: Library. Relevant only for \u0026#39;upstream_server\u0026#39; type.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_ca_credential_id","full_name":"ssl_ca_credential_id","description":"\n\u003cp\u003eContent Credential to use for SSL CA. Relevant only for \u0026#39;upstream_server\u0026#39; type.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_cdn_auth_enabled","full_name":"custom_cdn_auth_enabled","description":"\n\u003cp\u003eIf product certificates should be used to authenticate to a custom CDN.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/organizations/redhat_provider","name":"redhat_provider","apis":[{"api_url":"/katello/api/organizations/:id/redhat_provider","http_method":"GET","short_description":"List all :resource_id","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"package_groups":{"doc_url":"/apidoc/v2/package_groups","id":"package_groups","api_url":"/api","name":"Package_groups","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/package_groups/index","name":"index","apis":[{"api_url":"/katello/api/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_filter_ids","full_name":"include_filter_ids","description":"\n\u003cp\u003eIncludes associated content view filter ids in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/package_groups/show","name":"show","apis":[{"api_url":"/katello/api/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package group identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/package_groups/compare","name":"compare","apis":[{"api_url":"/katello/api/package_groups/compare","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"packages":{"doc_url":"/apidoc/v2/packages","id":"packages","api_url":"/api","name":"Packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/packages/index","name":"index","apis":[{"api_url":"/katello/api/packages","http_method":"GET","short_description":"List packages","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003ePackage identifiers to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable packages for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"packages_restrict_applicable","full_name":"packages_restrict_applicable","description":"\n\u003cp\u003eReturn packages that are applicable to one or more hosts (defaults to true if host_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"packages_restrict_upgradable","full_name":"packages_restrict_upgradable","description":"\n\u003cp\u003eReturn packages that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"packages_restrict_latest","full_name":"packages_restrict_latest","description":"\n\u003cp\u003eReturn only the latest version of each package\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn packages that can be added to the specified object. Only the value \u0026#39;content_view_version\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/packages/show","name":"show","apis":[{"api_url":"/katello/api/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/packages/compare","name":"compare","apis":[{"api_url":"/katello/api/packages/compare","http_method":"GET","short_description":"List packages","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products_bulk_actions":{"doc_url":"/apidoc/v2/products_bulk_actions","id":"products_bulk_actions","api_url":"/api","name":"Products_bulk_actions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/products_bulk_actions/destroy_products","name":"destroy_products","apis":[{"api_url":"/katello/api/products/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/products_bulk_actions/sync_products","name":"sync_products","apis":[{"api_url":"/katello/api/products/bulk/sync","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Non-yum repositories are skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Non-yum repositories (or those with On Demand download policy) are skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/products_bulk_actions/verify_checksum_products","name":"verify_checksum_products","apis":[{"api_url":"/katello/api/products/bulk/verify_checksum","http_method":"PUT","short_description":"Verify checksum for one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/products_bulk_actions/update_http_proxy","name":"update_http_proxy","apis":[{"api_url":"/katello/api/products/bulk/http_proxy","http_method":"PUT","short_description":"Update the HTTP proxy configuration on the repositories of one or more products.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicy for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eHTTP Proxy identifier to associated\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/products_bulk_actions/update_sync_plans","name":"update_sync_plans","apis":[{"api_url":"/katello/api/products/bulk/sync_plan","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"plan_id","full_name":"plan_id","description":"\n\u003cp\u003eSync plan identifier to attach\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products":{"doc_url":"/apidoc/v2/products","id":"products","api_url":"/api","name":"Products","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/products/index","name":"index","apis":[{"api_url":"/katello/api/products","http_method":"GET","short_description":"List products","deprecated":null},{"api_url":"/katello/api/subscriptions/:subscription_id/products","http_method":"GET","short_description":"List of subscription products in a subscription","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/products","http_method":"GET","short_description":"List of subscription products in an activation key","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/products","http_method":"GET","short_description":"List of products in an organization","deprecated":null},{"api_url":"/katello/api/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter products by organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eFilter products by subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eFilter products by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eReturn enabled products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom","full_name":"custom","description":"\n\u003cp\u003eReturn custom products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"redhat_only","full_name":"redhat_only","description":"\n\u003cp\u003eReturn Red Hat (non-custom) products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_available_content","full_name":"include_available_content","description":"\n\u003cp\u003eWhether to include available content attribute in results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003eFilter products by sync plan id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Products that can be associated with specified object. Only \u0026#39;sync_plan\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/products/create","name":"create","apis":[{"api_url":"/katello/api/products","http_method":"POST","short_description":"Create a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/products/show","name":"show","apis":[{"api_url":"/katello/api/products/:id","http_method":"GET","short_description":"Show a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/products/update","name":"update","apis":[{"api_url":"/katello/api/products/:id","http_method":"PUT","short_description":"Updates a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/products/destroy","name":"destroy","apis":[{"api_url":"/katello/api/products/:id","http_method":"DELETE","short_description":"Destroy a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/products/sync","name":"sync","apis":[{"api_url":"/katello/api/products/:id/sync","http_method":"POST","short_description":"Sync all repositories for a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"repositories_bulk_actions":{"doc_url":"/apidoc/v2/repositories_bulk_actions","id":"repositories_bulk_actions","api_url":"/api","name":"Repositories_bulk_actions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/repositories_bulk_actions/destroy_repositories","name":"destroy_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories_bulk_actions/sync_repositories","name":"sync_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/sync","http_method":"POST","short_description":"Synchronize repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories_bulk_actions/reclaim_space_from_repositories","name":"reclaim_space_from_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/reclaim_space","http_method":"POST","short_description":"Reclaim space from On Demand repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"repositories":{"doc_url":"/apidoc/v2/repositories","id":"repositories","api_url":"/api","name":"Repositories","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/repositories/index","name":"index","apis":[{"api_url":"/katello/api/repositories","http_method":"GET","short_description":"List of enabled repositories","deprecated":null},{"api_url":"/katello/api/content_views/:id/repositories","http_method":"GET","short_description":"List of repositories for a content view","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/repositories","http_method":"GET","short_description":"List of repositories in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id/repositories","http_method":"GET","short_description":"List repositories in the environment","deprecated":null},{"api_url":"/katello/api/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories for a product","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories belonging to a product in an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of an organization to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to show repositories of\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of an environment to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eID of a content view to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eID of a content view version to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deb_id","full_name":"deb_id","description":"\n\u003cp\u003eId of a deb package to find repositories that contain the deb\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"erratum_id","full_name":"erratum_id","description":"\n\u003cp\u003eId of an erratum to find repositories that contain the erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rpm_id","full_name":"rpm_id","description":"\n\u003cp\u003eId of a rpm package to find repositories that contain the rpm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"file_id","full_name":"file_id","description":"\n\u003cp\u003eId of a file to find repositories that contain the file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_collection_id","full_name":"ansible_collection_id","description":"\n\u003cp\u003eId of an ansible collection to find repositories that contain the ansible collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"library","full_name":"library","description":"\n\u003cp\u003eshow repositories in Library and the default content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"archived","full_name":"archived","description":"\n\u003cp\u003eshow archived repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eLimit the repository type. Available types endpoint: /katello/api/repositories/repository_types\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003einterpret specified object to return only Repositories that can be associated with specified object. Only \u0026#39;content_view\u0026#39; \u0026amp; \u0026#39;content_view_version\u0026#39; are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_content","full_name":"with_content","description":"\n\u003cp\u003eFilter repositories by content unit type (erratum, docker_tag, etc.). Check the “Indexed?” types here: /katello/api/repositories/repository_types\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003elimit to only repositories with this download policy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eimmediate\u003c/code\u003e, \u003ccode\u003eon_demand\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"username","description":"\n\u003cp\u003eonly show the repositories readable by this user with this username\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"container_repository_name","type":"string"},{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"distribution_arch","type":"string"},{"name":"distribution_bootable","type":"boolean"},{"name":"distribution_family","type":"string"},{"name":"distribution_variant","type":"string"},{"name":"distribution_version","type":"string"},{"name":"download_policy","type":"string"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"product","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/compare","name":"compare","apis":[{"api_url":"/katello/api/repositories/compare","http_method":"GET","short_description":"List :resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/create","name":"create","apis":[{"api_url":"/katello/api/repositories","http_method":"POST","short_description":"Create a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the repository\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eProduct the repository belongs to\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eType of repository. Available types endpoint: /katello/api/repositories/repository_types\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_versions","full_name":"os_versions","description":"\n\u003cp\u003eIdentifies whether the repository should be unavailable on a client with a non-matching OS version. Pass [] to make repo available for clients regardless of OS version. Maximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8, rhel-9\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39; are supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_tags","full_name":"include_tags","description":"\n\u003cp\u003eComma-separated list of tags to sync for a container image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude_tags","full_name":"exclude_tags","description":"\n\u003cp\u003eComma-separated list of tags to exclude when syncing a container image repository. Default: any tag ending in “-source”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum, deb, and docker repos (either \u0026#39;immediate\u0026#39; or \u0026#39;on_demand\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eimmediate\u003c/code\u003e, \u003ccode\u003eon_demand\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"download_concurrency","full_name":"download_concurrency","description":"\n\u003cp\u003eUsed to determine download concurrency of the repository in pulp3. Use value less than 20. Defaults to 10\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mirroring_policy","full_name":"mirroring_policy","description":"\n\u003cp\u003ePolicy to set for mirroring content. Must be one of additive.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eadditive\u003c/code\u003e, \u003ccode\u003emirror_complete\u003c/code\u003e, \u003ccode\u003emirror_content_only\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are signed by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_authentication_token","full_name":"upstream_authentication_token","description":"\n\u003cp\u003ePassword of the upstream authentication token.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ewhitespace-separated list of releases to be synced from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ewhitespace-separated list of repo components to be synced from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ewhitespace-separated list of architectures to be synced from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be subset of srpm,treeinfo\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_collection_auth_url","full_name":"ansible_collection_auth_url","description":"\n\u003cp\u003eThe URL to receive a session token from, e.g. used with Automation Hub.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_collection_auth_token","full_name":"ansible_collection_auth_token","description":"\n\u003cp\u003eThe token key to use for authentication.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"arch","full_name":"arch","description":"\n\u003cp\u003eArchitecture of content in the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retain_package_versions_count","full_name":"retain_package_versions_count","description":"\n\u003cp\u003eThe maximum number of versions of each package to keep.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"metadata_expire","full_name":"metadata_expire","description":"\n\u003cp\u003eTime to expire yum metadata in seconds. Only relevant for custom yum repositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"excludes","full_name":"excludes","description":"\n\u003cp\u003ePython packages to exclude from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003ePython packages to include from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0. Leave empty to include every package.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"package_types","full_name":"package_types","description":"\n\u003cp\u003ePackage types to sync for Python content, separated by comma. Leave empty to get every package type. Package types are: bdist_dmg, bdist_dumb, bdist_egg, bdist_msi, bdist_rpm, bdist_wheel, bdist_wininst, sdist.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/repository_types","name":"repository_types","apis":[{"api_url":"/katello/api/repositories/repository_types","http_method":"GET","short_description":"Show the available repository types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"creatable","full_name":"creatable","description":"\n\u003cp\u003eWhen set to \u0026#39;True\u0026#39; repository types that are creatable will be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/republish","name":"republish","apis":[{"api_url":"/katello/api/repositories/:id/republish","http_method":"PUT","short_description":"Forces a republish of the specified repository, regenerating metadata and symlinks on the filesystem. Not allowed for repositories with the 'Complete Mirroring' mirroring policy.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force","full_name":"force","description":"\n\u003cp\u003eForce metadata regeneration to proceed. Dangerous when repositories use the \u0026#39;Complete Mirroring\u0026#39; mirroring policy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/show","name":"show","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"GET","short_description":"Show a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/sync","name":"sync","apis":[{"api_url":"/katello/api/repositories/:id/sync","http_method":"POST","short_description":"Sync a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"source_url","full_name":"source_url","description":"\n\u003cp\u003etemporarily override feed URL for sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"incremental","full_name":"incremental","description":"\n\u003cp\u003eperform an incremental import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Only used with yum or deb repositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Only used with yum repositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/verify_checksum","name":"verify_checksum","apis":[{"api_url":"/katello/api/repositories/:id/verify_checksum","http_method":"POST","short_description":"Verify checksum of repository contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/reclaim_space","name":"reclaim_space","apis":[{"api_url":"/katello/api/repositories/:id/reclaim_space","http_method":"POST","short_description":"Reclaim space from an On Demand repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"PUT","short_description":"Update a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_versions","full_name":"os_versions","description":"\n\u003cp\u003eIdentifies whether the repository should be unavailable on a client with a non-matching OS version. Pass [] to make repo available for clients regardless of OS version. Maximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8, rhel-9\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39; are supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_tags","full_name":"include_tags","description":"\n\u003cp\u003eComma-separated list of tags to sync for a container image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude_tags","full_name":"exclude_tags","description":"\n\u003cp\u003eComma-separated list of tags to exclude when syncing a container image repository. Default: any tag ending in “-source”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum, deb, and docker repos (either \u0026#39;immediate\u0026#39; or \u0026#39;on_demand\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eimmediate\u003c/code\u003e, \u003ccode\u003eon_demand\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"download_concurrency","full_name":"download_concurrency","description":"\n\u003cp\u003eUsed to determine download concurrency of the repository in pulp3. Use value less than 20. Defaults to 10\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mirroring_policy","full_name":"mirroring_policy","description":"\n\u003cp\u003ePolicy to set for mirroring content. Must be one of additive.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eadditive\u003c/code\u003e, \u003ccode\u003emirror_complete\u003c/code\u003e, \u003ccode\u003emirror_content_only\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are signed by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_authentication_token","full_name":"upstream_authentication_token","description":"\n\u003cp\u003ePassword of the upstream authentication token.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ewhitespace-separated list of releases to be synced from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ewhitespace-separated list of repo components to be synced from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ewhitespace-separated list of architectures to be synced from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be subset of srpm,treeinfo\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_collection_auth_url","full_name":"ansible_collection_auth_url","description":"\n\u003cp\u003eThe URL to receive a session token from, e.g. used with Automation Hub.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_collection_auth_token","full_name":"ansible_collection_auth_token","description":"\n\u003cp\u003eThe token key to use for authentication.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"arch","full_name":"arch","description":"\n\u003cp\u003eArchitecture of content in the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retain_package_versions_count","full_name":"retain_package_versions_count","description":"\n\u003cp\u003eThe maximum number of versions of each package to keep.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"metadata_expire","full_name":"metadata_expire","description":"\n\u003cp\u003eTime to expire yum metadata in seconds. Only relevant for custom yum repositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"excludes","full_name":"excludes","description":"\n\u003cp\u003ePython packages to exclude from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003ePython packages to include from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0. Leave empty to include every package.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"package_types","full_name":"package_types","description":"\n\u003cp\u003ePackage types to sync for Python content, separated by comma. Leave empty to get every package type. Package types are: bdist_dmg, bdist_dumb, bdist_egg, bdist_msi, bdist_rpm, bdist_wheel, bdist_wininst, sdist.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"DELETE","short_description":"Destroy a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_from_content_view_versions","full_name":"remove_from_content_view_versions","description":"\n\u003cp\u003eForce delete the repository by removing it from all content view versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delete_empty_repo_filters","full_name":"delete_empty_repo_filters","description":"\n\u003cp\u003eDelete content view filters that have this repository as the last associated repository. Defaults to true. If false, such filters will now apply to all repositories in the content view.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/remove_content","name":"remove_content","apis":[{"api_url":"/katello/api/repositories/:id/remove_packages","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_docker_manifests","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_content","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove content from a repository\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of content ids to remove\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content to remove (srpm, docker_manifest, etc.). Check removable types here: /katello/api/repositories/repository_types\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/upload_content","name":"upload_content","apis":[{"api_url":"/katello/api/repositories/:id/upload_content","http_method":"POST","short_description":"Upload content into the repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"\n\u003cp\u003eContent files to upload. Can be a single file or array of files.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content to upload (srpm, file, etc.). Check uploadable types here: /katello/api/repositories/repository_types\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/import_uploads","name":"import_uploads","apis":[{"api_url":"/katello/api/repositories/:id/import_uploads","http_method":"PUT","short_description":"Import uploads into a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the ImportUpload action to finish. Default: false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"publish_repository","full_name":"publish_repository","description":"\n\u003cp\u003eWhether or not to regenerate the repository on disk. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;, \u0026#39;ostree_ref\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003eostree_ref\u003c/code\u003e, \u003ccode\u003epython_package\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uploads","full_name":"uploads","description":"\n\u003cp\u003eArray of uploads to import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"uploads[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_unit_id","full_name":"uploads[content_unit_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"uploads[size]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"checksum","full_name":"uploads[checksum]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"uploads[name]","description":"\n\u003cp\u003eNeeds to only be set for file repositories or docker tags\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"digest","full_name":"uploads[digest]","description":"\n\u003cp\u003eNeeds to only be set for docker tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"ostree_ref","full_name":"ostree_ref","description":"\n\u003cp\u003eOSTree ref branch that holds the reference to the last commit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ostree_repository_name","full_name":"ostree_repository_name","description":"\n\u003cp\u003eName of the repository in the ostree archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/gpg_key_content","name":"gpg_key_content","apis":[{"api_url":"/katello/api/repositories/:id/gpg_key_content","http_method":"GET","short_description":"Return the content of a repo gpg key, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repositories/content_types","name":"content_types","apis":[{"api_url":"/katello/api/content_types","http_method":"GET","short_description":"Return the enabled content types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"repository_sets":{"doc_url":"/apidoc/v2/repository_sets","id":"repository_sets","api_url":"/api","name":"Repository_sets","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/repository_sets/index","name":"index","apis":[{"api_url":"/katello/api/repository_sets","http_method":"GET","short_description":"List repository sets.","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets","http_method":"GET","short_description":"List repository sets for a product.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eRepository set name to search on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eIf true, only return repository sets that have been enabled. Defaults to false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_active_subscription","full_name":"with_active_subscription","description":"\n\u003cp\u003eIf true, only return repository sets that are associated with an active subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_custom","full_name":"with_custom","description":"\n\u003cp\u003eIf true, return custom repository sets along with redhat repos. Will be ignored if repository_type is supplied.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eactivation key identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the host\u0026#39;s or activation key\u0026#39;s content view version and lifecycle environment.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eLimit content to enabled / disabled / overridden\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eenabled\u003c/code\u003e, \u003ccode\u003edisabled\u003c/code\u003e, \u003ccode\u003eoverridden\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_type","full_name":"repository_type","description":"\n\u003cp\u003eLimit content to Red Hat / custom\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eredhat\u003c/code\u003e, \u003ccode\u003ecustom\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"enabled_by_default","values":["true","false"]},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"path","type":"string"},{"name":"product","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repository_sets/show","name":"show","apis":[{"api_url":"/katello/api/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repository_sets/available_repositories","name":"available_repositories","apis":[{"api_url":"/katello/api/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repository_sets/enable","name":"enable","apis":[{"api_url":"/katello/api/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to enable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/repository_sets/disable","name":"disable","apis":[{"api_url":"/katello/api/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to disable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eID of the repository within the set to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"simple_content_access":{"doc_url":"/apidoc/v2/simple_content_access","id":"simple_content_access","api_url":"/api","name":"Simple_content_access","short_description":null,"full_description":"\n\u003cp\u003eRed Hat subscriptions management platform.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/simple_content_access/eligible","name":"eligible","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/eligible","http_method":"GET","short_description":"Check if the specified organization is eligible for Simple Content Access. WARNING: Simple Content Access will be required for all organizations in Katello 4.12.","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/simple_content_access/status","name":"status","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/status","http_method":"GET","short_description":"Check if the specified organization has Simple Content Access enabled. WARNING: Simple Content Access will be required for all organizations in Katello 4.12.","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/simple_content_access/enable","name":"enable","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/enable","http_method":"PUT","short_description":"Enable simple content access for a manifest","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/simple_content_access/disable","name":"disable","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/disable","http_method":"PUT","short_description":"Disable simple content access for a manifest. WARNING: Simple Content Access will be required for all organizations in Katello 4.12.","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"srpms":{"doc_url":"/apidoc/v2/srpms","id":"srpms","api_url":"/api","name":"Srpms","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/srpms/index","name":"index","apis":[{"api_url":"/katello/api/srpms","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/srpms/show","name":"show","apis":[{"api_url":"/katello/api/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSRPM details identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/srpms/compare","name":"compare","apis":[{"api_url":"/katello/api/srpms/compare","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_comparison","full_name":"restrict_comparison","description":"\n\u003cp\u003eReturn same, different or all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subscriptions":{"doc_url":"/apidoc/v2/subscriptions","id":"subscriptions","api_url":"/api","name":"Subscriptions","short_description":null,"full_description":"\n\u003cp\u003eSubscriptions management.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions","http_method":"GET","short_description":"List organization subscriptions","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/subscriptions","http_method":"GET","short_description":"List an activation key's subscriptions","deprecated":null},{"api_url":"/katello/api/subscriptions","http_method":"GET","short_description":"List subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of a host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eActivation key ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eObject to show subscriptions available for, either \u0026#39;host\u0026#39; or \u0026#39;activation_key\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"match_host","full_name":"match_host","description":"\n\u003cp\u003eIgnore subscriptions that are unavailable to the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"match_installed","full_name":"match_installed","description":"\n\u003cp\u003eReturn subscriptions that match installed products of the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_overlap","full_name":"no_overlap","description":"\n\u003cp\u003eReturn subscriptions which do not overlap with a currently-attached subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/subscriptions/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null},{"api_url":"/katello/api/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/subscriptions/upload","name":"upload","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/upload","http_method":"POST","short_description":"Upload a subscription manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"\n\u003cp\u003eSubscription manifest file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/subscriptions/refresh_manifest","name":"refresh_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/refresh_manifest","http_method":"PUT","short_description":"Refresh previously imported manifest for Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/subscriptions/delete_manifest","name":"delete_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/delete_manifest","http_method":"POST","short_description":"Delete manifest from Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/subscriptions/manifest_history","name":"manifest_history","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/manifest_history","http_method":"GET","short_description":"obtain manifest history for subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sync":{"doc_url":"/apidoc/v2/sync","id":"sync","api_url":"/api","name":"Sync","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/sync/index","name":"index","apis":[{"api_url":"/katello/api/repositories/:repository_id/sync","http_method":"GET","short_description":"Get status of synchronisation for given repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"sync_plans":{"doc_url":"/apidoc/v2/sync_plans","id":"sync_plans","api_url":"/api","name":"Sync_plans","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/sync_plans/index","name":"index","apis":[{"api_url":"/katello/api/sync_plans","http_method":"GET","short_description":"List sync plans","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003efilter by sync date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003efilter by interval\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"enabled","values":["true","false"]},{"name":"interval","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/sync_plans/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/sync_plans/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"POST","short_description":"Create a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/sync_plans/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/sync_plans/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/sync_plans/add_products","name":"add_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/add_products","http_method":"PUT","short_description":"Add products to sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to add to the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/sync_plans/remove_products","name":"remove_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/remove_products","http_method":"PUT","short_description":"Remove products from sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to remove from the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/sync_plans/sync","name":"sync","apis":[{"api_url":"/katello/api/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"upstream_subscriptions":{"doc_url":"/apidoc/v2/upstream_subscriptions","id":"upstream_subscriptions","api_url":"/api","name":"Upstream_subscriptions","short_description":null,"full_description":"\n\u003cp\u003eRed Hat subscriptions management platform.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/upstream_subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"GET","short_description":"List available subscriptions from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eThe order to sort the results in. [\u0026#39;asc\u0026#39;, \u0026#39;desc\u0026#39;] Defaults to \u0026#39;desc\u0026#39;.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eThe field to sort the data by. Defaults to the created date.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eReturn only the upstream pools which map to the given Katello pool IDs\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantities_only","full_name":"quantities_only","description":"\n\u003cp\u003eOnly returns id and quantity fields\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attachable","full_name":"attachable","description":"\n\u003cp\u003eReturn only subscriptions which can be attached to the upstream allocation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/upstream_subscriptions/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"PUT","short_description":"Update the quantity of one or more subscriptions on an upstream allocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of Pools to be updated. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eKatello ID of local pool to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eDesired quantity of the pool\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/upstream_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"DELETE","short_description":"Remove one or more subscriptions from an upstream manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eArray of local pool IDs. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/upstream_subscriptions/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"POST","short_description":"Add subscriptions consumed by a manifest from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of pools to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eCandlepin ID of pool to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eQuantity of entitlements to bind\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/upstream_subscriptions/ping","name":"ping","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions/ping","http_method":"GET","short_description":"Check if a connection can be made to Red Hat Subscription Management.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ansible_inventories":{"doc_url":"/apidoc/v2/ansible_inventories","id":"ansible_inventories","api_url":"/api","name":"Ansible_inventories","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/ansible_inventories/hosts","name":"hosts","apis":[{"api_url":"/ansible/api/ansible_inventories/hosts","http_method":"POST","short_description":"Show Ansible inventory for hosts","deprecated":null},{"api_url":"/ansible/api/ansible_inventories/hosts","http_method":"GET","short_description":"Show Ansible inventory for hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eIDs of hosts included in inventory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_inventories/hostgroups","name":"hostgroups","apis":[{"api_url":"/ansible/api/ansible_inventories/hostgroups","http_method":"POST","short_description":"Show Ansible inventory for hostgroups","deprecated":null},{"api_url":"/ansible/api/ansible_inventories/hostgroups","http_method":"GET","short_description":"Show Ansible inventory for hostgroups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_ids","full_name":"hostgroup_ids","description":"\n\u003cp\u003eIDs of hostgroups included in inventory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_inventories/schedule","name":"schedule","apis":[{"api_url":"/ansible/api/ansible_inventories/schedule","http_method":"POST","short_description":"Schedule generating of Ansible Inventory report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values of type input=\u0026gt;value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;json\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["POST /ansible/api/ansible_inventories/schedule\n{\n \"input_values\": {\n \"Organization\": \"yes\",\n \"Location\": \"yes\",\n \"IPv4\": \"yes\",\n \"Facts\": \"no\"\n }\n}\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ansible_override_values":{"doc_url":"/apidoc/v2/ansible_override_values","id":"ansible_override_values","api_url":"/api","name":"Ansible_override_values","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/ansible_override_values/create","name":"create","apis":[{"api_url":"/ansible/api/ansible_override_values","http_method":"POST","short_description":"Create an override value for a specific ansible variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_variable_id","full_name":"ansible_variable_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_override_values/destroy","name":"destroy","apis":[{"api_url":"/ansible/api/ansible_override_values/:id","http_method":"DELETE","short_description":"Destroy an override value","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ansible_playbooks":{"doc_url":"/apidoc/v2/ansible_playbooks","id":"ansible_playbooks","api_url":"/api","name":"Ansible_playbooks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/ansible_playbooks/sync","name":"sync","apis":[{"api_url":"/ansible/api/ansible_playbooks/sync","http_method":"PUT","short_description":"Sync Ansible playbooks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to sync from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"playbooks_names","full_name":"playbooks_names","description":"\n\u003cp\u003eAnsible playbooks names to be synced\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_playbooks/fetch","name":"fetch","apis":[{"api_url":"/ansible/api/ansible_playbooks/fetch","http_method":"GET","short_description":"Fetch Ansible playbooks available to be synced","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to fetch from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ansible_roles":{"doc_url":"/apidoc/v2/ansible_roles","id":"ansible_roles","api_url":"/api","name":"Ansible_roles","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/ansible_roles/show","name":"show","apis":[{"api_url":"/ansible/api/ansible_roles/:id","http_method":"GET","short_description":"Show role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_roles/index","name":"index","apis":[{"api_url":"/ansible/api/ansible_roles","http_method":"GET","short_description":"List Ansible roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_id","type":"integer"},{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"updated_at","type":"datetime"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_roles/destroy","name":"destroy","apis":[{"api_url":"/ansible/api/ansible_roles/:id","http_method":"DELETE","short_description":"Deletes Ansible role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_roles/import","name":"import","apis":[{"api_url":"/ansible/api/ansible_roles/import","http_method":"PUT","short_description":"DEPRECATED: Import Ansible roles","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to import from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_names","full_name":"role_names","description":"\n\u003cp\u003eAnsible role names to be imported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_roles/sync","name":"sync","apis":[{"api_url":"/ansible/api/ansible_roles/sync","http_method":"PUT","short_description":"Sync Ansible roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to sync from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_names","full_name":"role_names","description":"\n\u003cp\u003eAnsible role names to be synced\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_roles/obsolete","name":"obsolete","apis":[{"api_url":"/ansible/api/ansible_roles/obsolete","http_method":"PUT","short_description":"DEPRECATED: Obsolete Ansible roles","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to import from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_roles/fetch","name":"fetch","apis":[{"api_url":"/ansible/api/ansible_roles/fetch","http_method":"GET","short_description":"Fetch Ansible roles available to be synced","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to fetch from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ansible_variables":{"doc_url":"/apidoc/v2/ansible_variables","id":"ansible_variables","api_url":"/api","name":"Ansible_variables","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/ansible_variables/show","name":"show","apis":[{"api_url":"/ansible/api/ansible_variables/:id","http_method":"GET","short_description":"Show variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_variables/index","name":"index","apis":[{"api_url":"/ansible/api/ansible_variables","http_method":"GET","short_description":"List Ansible variables","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"ansible_role","type":"string"},{"name":"avoid_duplicates","values":["true","false"]},{"name":"imported","values":["true","false"]},{"name":"key","type":"string"},{"name":"merge_default","values":["true","false"]},{"name":"merge_overrides","values":["true","false"]},{"name":"name","type":"string"},{"name":"override","values":["true","false"]},{"name":"parameter","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_variables/destroy","name":"destroy","apis":[{"api_url":"/ansible/api/ansible_variables/:id","http_method":"DELETE","short_description":"Deletes Ansible variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_variables/create","name":"create","apis":[{"api_url":"/ansible/api/ansible_variables","http_method":"POST","short_description":"Create Ansible variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_variable","full_name":"ansible_variable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"variable","full_name":"ansible_variable[variable]","description":"\n\u003cp\u003eName of variable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_role_id","full_name":"ansible_variable[ansible_role_id]","description":"\n\u003cp\u003eRole ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default_value","full_name":"ansible_variable[default_value]","description":"\n\u003cp\u003eDefault value of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"ansible_variable[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override_value_order","full_name":"ansible_variable[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"ansible_variable[description]","description":"\n\u003cp\u003eDescription of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"validator_type","full_name":"ansible_variable[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"validator_rule","full_name":"ansible_variable[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"variable_type","full_name":"ansible_variable[variable_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"merge_overrides","full_name":"ansible_variable[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"merge_default","full_name":"ansible_variable[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"avoid_duplicates","full_name":"ansible_variable[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override","full_name":"ansible_variable[override]","description":"\n\u003cp\u003eWhether to override variable or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_variables/update","name":"update","apis":[{"api_url":"/ansible/api/ansible_variables/:id","http_method":"PUT","short_description":"Updates Ansible variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_variable","full_name":"ansible_variable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"variable","full_name":"ansible_variable[variable]","description":"\n\u003cp\u003eName of variable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ansible_role_id","full_name":"ansible_variable[ansible_role_id]","description":"\n\u003cp\u003eRole ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default_value","full_name":"ansible_variable[default_value]","description":"\n\u003cp\u003eDefault value of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"ansible_variable[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override_value_order","full_name":"ansible_variable[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"ansible_variable[description]","description":"\n\u003cp\u003eDescription of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"validator_type","full_name":"ansible_variable[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"validator_rule","full_name":"ansible_variable[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"variable_type","full_name":"ansible_variable[variable_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"merge_overrides","full_name":"ansible_variable[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"merge_default","full_name":"ansible_variable[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"avoid_duplicates","full_name":"ansible_variable[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override","full_name":"ansible_variable[override]","description":"\n\u003cp\u003eWhether to override variable or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_variables/import","name":"import","apis":[{"api_url":"/ansible/api/ansible_variables/import","http_method":"PUT","short_description":"DEPRECATED: Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to import from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ansible_variables/obsolete","name":"obsolete","apis":[{"api_url":"/ansible/api/ansible_variables/obsolete","http_method":"PUT","short_description":"DEPRECATED: Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"proxy_id","full_name":"proxy_id","description":"\n\u003cp\u003eSmart Proxy to import from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"disks":{"doc_url":"/apidoc/v2/disks","id":"disks","api_url":"/api","name":"Disks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/disks/index","name":"index","apis":[{"api_url":"/api/bootdisk","http_method":"GET","short_description":"Boot disks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/disks/generic","name":"generic","apis":[{"api_url":"/api/bootdisk/generic","http_method":"GET","short_description":"Download generic image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/disks/host","name":"host","apis":[{"api_url":"/api/bootdisk/hosts/:host_id","http_method":"GET","short_description":"Download host image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"full","full_name":"full","description":"\n\u003cp\u003eTrue for full, false for basic reusable image\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subnet_disks":{"doc_url":"/apidoc/v2/subnet_disks","id":"subnet_disks","api_url":"/api","name":"Subnet_disks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/subnet_disks/index","name":"index","apis":[{"api_url":"/api/bootdisk","http_method":"GET","short_description":"Subnet boot disks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/subnet_disks/subnet","name":"subnet","apis":[{"api_url":"/api/bootdisk/subnets/:subnet_id","http_method":"GET","short_description":"Download subnet generic image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"subnet_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"discovered_hosts":{"doc_url":"/apidoc/v2/discovered_hosts","id":"discovered_hosts","api_url":"/api","name":"Discovered_hosts","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/discovered_hosts/index","name":"index","apis":[{"api_url":"/api/v2/discovered_hosts","http_method":"GET","short_description":"List all discovered hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovered_hosts/show","name":"show","apis":[{"api_url":"/api/v2/discovered_hosts/:id","http_method":"GET","short_description":"Show a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovered_hosts/create","name":"create","apis":[{"api_url":"/api/v2/discovered_hosts","http_method":"POST","short_description":"Create a discovered host for testing (use /facts to create new hosts)","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discovered_host","full_name":"discovered_host","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"discovered_host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip","full_name":"discovered_host[ip]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mac","full_name":"discovered_host[mac]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pxe_loader","full_name":"discovered_host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2 or PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovered_hosts/update","name":"update","apis":[{"api_url":"/api/v2/discovered_hosts/:id","http_method":"PUT","short_description":"Provision a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discovered_host","full_name":"discovered_host","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"discovered_host[name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_id","full_name":"discovered_host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ip","full_name":"discovered_host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mac","full_name":"discovered_host[mac]","description":"\n\u003cp\u003enot required if it\u0026#39;s a virtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_id","full_name":"discovered_host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"discovered_host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"puppet_proxy_id","full_name":"discovered_host[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"puppet_class_ids","full_name":"discovered_host[puppet_class_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"discovered_host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_id","full_name":"discovered_host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_id","full_name":"discovered_host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"discovered_host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sp_subnet_id","full_name":"discovered_host[sp_subnet_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"model_id","full_name":"discovered_host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"discovered_host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_id","full_name":"discovered_host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_type","full_name":"discovered_host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"puppet_ca_proxy_id","full_name":"discovered_host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image_id","full_name":"discovered_host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_parameters_attributes","full_name":"discovered_host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"discovered_host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"discovered_host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter_type","full_name":"discovered_host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"discovered_host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"build","full_name":"discovered_host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"discovered_host[enabled]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provision_method","full_name":"discovered_host[provision_method]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managed","full_name":"discovered_host[managed]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"progress_report_id","full_name":"discovered_host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"capabilities","full_name":"discovered_host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root_pass","full_name":"discovered_host[root_pass]","description":"\n\u003cp\u003erequired if value is not inherited from host group or default password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pxe_loader","full_name":"discovered_host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2 or PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovered_hosts/destroy","name":"destroy","apis":[{"api_url":"/api/v2/discovered_hosts/:id","http_method":"DELETE","short_description":"Delete a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovered_hosts/facts","name":"facts","apis":[{"api_url":"/api/v2/discovered_hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing facts for the host with minimum set of facts: discovery_bootif, macaddress_eth0, ipaddress, ipaddress_eth0, interfaces: eth0 (example in case primary interface is named eth0)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovered_hosts/auto_provision","name":"auto_provision","apis":[{"api_url":"/api/v2/discovered_hosts/:id/auto_provision","http_method":"POST","short_description":"Execute rules against a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovered_hosts/auto_provision_all","name":"auto_provision_all","apis":[{"api_url":"/api/v2/discovered_hosts/auto_provision_all","http_method":"POST","short_description":"Execute rules against all currently discovered hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovered_hosts/refresh_facts","name":"refresh_facts","apis":[{"api_url":"/api/v2/discovered_hosts/:id/refresh_facts","http_method":"PUT","short_description":"Refreshing the facts of a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovered_hosts/reboot","name":"reboot","apis":[{"api_url":"/api/v2/discovered_hosts/:id/reboot","http_method":"PUT","short_description":"Rebooting a discovered host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovered_hosts/reboot_all","name":"reboot_all","apis":[{"api_url":"/api/v2/discovered_hosts/reboot_all","http_method":"PUT","short_description":"Rebooting all discovered hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"discovery_rules":{"doc_url":"/apidoc/v2/discovery_rules","id":"discovery_rules","api_url":"/api","name":"Discovery_rules","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/discovery_rules/index","name":"index","apis":[{"api_url":"/api/v2/discovery_rules","http_method":"GET","short_description":"List all discovery rules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovery_rules/show","name":"show","apis":[{"api_url":"/api/v2/discovery_rules/:id","http_method":"GET","short_description":"Show a discovery rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovery_rules/create","name":"create","apis":[{"api_url":"/api/v2/discovery_rules","http_method":"POST","short_description":"Create a discovery rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discovery_rule","full_name":"discovery_rule","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"discovery_rule[name]","description":"\n\u003cp\u003erepresents rule name shown to the users\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"discovery_rule[search]","description":"\n\u003cp\u003equery to match discovered hosts for the particular rule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"discovery_rule[hostgroup_id]","description":"\n\u003cp\u003ethe hostgroup that is used to auto provision a host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostname","full_name":"discovery_rule[hostname]","description":"\n\u003cp\u003edefines a pattern to assign human-readable hostnames to the matching hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_count","full_name":"discovery_rule[max_count]","description":"\n\u003cp\u003eenables to limit maximum amount of provisioned hosts per rule\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"priority","full_name":"discovery_rule[priority]","description":"\n\u003cp\u003eputs the rules in order, low numbers go first. Must be greater then zero\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"discovery_rule[enabled]","description":"\n\u003cp\u003eflag is used for temporary shutdown of rules\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"discovery_rule[location_ids]","description":"\n\u003cp\u003elocation ID for provisioned hosts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"discovery_rule[organization_ids]","description":"\n\u003cp\u003eorganization ID for provisioned hosts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovery_rules/update","name":"update","apis":[{"api_url":"/api/v2/discovery_rules/:id","http_method":"PUT","short_description":"Update a rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"discovery_rule","full_name":"discovery_rule","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"discovery_rule[name]","description":"\n\u003cp\u003erepresents rule name shown to the users\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"discovery_rule[search]","description":"\n\u003cp\u003equery to match discovered hosts for the particular rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"discovery_rule[hostgroup_id]","description":"\n\u003cp\u003ethe hostgroup that is used to auto provision a host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostname","full_name":"discovery_rule[hostname]","description":"\n\u003cp\u003edefines a pattern to assign human-readable hostnames to the matching hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_count","full_name":"discovery_rule[max_count]","description":"\n\u003cp\u003eenables to limit maximum amount of provisioned hosts per rule\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"priority","full_name":"discovery_rule[priority]","description":"\n\u003cp\u003eputs the rules in order, low numbers go first. Must be greater then zero\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"discovery_rule[enabled]","description":"\n\u003cp\u003eflag is used for temporary shutdown of rules\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"discovery_rule[location_ids]","description":"\n\u003cp\u003elocation ID for provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"discovery_rule[organization_ids]","description":"\n\u003cp\u003eorganization ID for provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/discovery_rules/destroy","name":"destroy","apis":[{"api_url":"/api/v2/discovery_rules/:id","http_method":"DELETE","short_description":"Delete a rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"arf_reports":{"doc_url":"/apidoc/v2/arf_reports","id":"arf_reports","api_url":"/api","name":"Arf_reports","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/arf_reports/index","name":"index","apis":[{"api_url":"/api/compliance/arf_reports","http_method":"GET","short_description":"List ARF reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compliance_policy","type":"string"},{"name":"compliance_status","values":["compliant","incompliant","inconclusive"]},{"name":"comply_with","type":"string"},{"name":"eventful","values":["true","false"]},{"name":"host","type":"string"},{"name":"host_collection","type":"string"},{"name":"host_id","type":"integer"},{"name":"host_owner_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"inconclusive_with","type":"string"},{"name":"last_for","values":["host","policy"]},{"name":"last_report","type":"datetime"},{"name":"lifecycle_environment","type":""},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"log","type":"text"},{"name":"not_comply_with","type":"string"},{"name":"openscap_proxy","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"policy","type":"string"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"xccdf_rule_failed","type":"string"},{"name":"xccdf_rule_name","type":"text"},{"name":"xccdf_rule_othered","type":"string"},{"name":"xccdf_rule_passed","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/arf_reports/show","name":"show","apis":[{"api_url":"/api/compliance/arf_reports/:id","http_method":"GET","short_description":"Show an ARF report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/arf_reports/destroy","name":"destroy","apis":[{"api_url":"/api/compliance/arf_reports/:id","http_method":"DELETE","short_description":"Delete an ARF Report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/arf_reports/create","name":"create","apis":[{"api_url":"/api/compliance/arf/:cname/:policy_id/:date","http_method":"POST","short_description":"Upload an ARF report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cname","full_name":"cname","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"policy_id","full_name":"policy_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date","full_name":"date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/arf_reports/download","name":"download","apis":[{"api_url":"/api/compliance/arf_reports/:id/download","http_method":"GET","short_description":"Download bzipped ARF report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/arf_reports/download_html","name":"download_html","apis":[{"api_url":"/api/compliance/arf_reports/:id/download_html","http_method":"GET","short_description":"Download ARF report in HTML","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"oval_contents":{"doc_url":"/apidoc/v2/oval_contents","id":"oval_contents","api_url":"/api","name":"Oval_contents","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/oval_contents/index","name":"index","apis":[{"api_url":"/api/compliance/oval_contents","http_method":"GET","short_description":"List OVAL contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_contents/show","name":"show","apis":[{"api_url":"/api/compliance/oval_contents/:id","http_method":"GET","short_description":"Show an OVAL content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_contents/create","name":"create","apis":[{"api_url":"/api/compliance/oval_contents","http_method":"POST","short_description":"Create OVAL content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"oval_content","full_name":"oval_content","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"oval_content[name]","description":"\n\u003cp\u003eOVAL content name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_file","full_name":"oval_content[scap_file]","description":"\n\u003cp\u003eXML containing OVAL content\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_filename","full_name":"oval_content[original_filename]","description":"\n\u003cp\u003eOriginal file name of the OVAL content file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"oval_content[url]","description":"\n\u003cp\u003eURL of the OVAL content file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"oval_content[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"oval_content[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_contents/update","name":"update","apis":[{"api_url":"/api/compliance/oval_contents/:id","http_method":"PUT","short_description":"Update an OVAL content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"oval_content","full_name":"oval_content","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"oval_content[name]","description":"\n\u003cp\u003eOVAL content name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_file","full_name":"oval_content[scap_file]","description":"\n\u003cp\u003eXML containing OVAL content\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_filename","full_name":"oval_content[original_filename]","description":"\n\u003cp\u003eOriginal file name of the OVAL content file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"oval_content[url]","description":"\n\u003cp\u003eURL of the OVAL content file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"oval_content[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"oval_content[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_contents/destroy","name":"destroy","apis":[{"api_url":"/api/compliance/oval_contents/:id","http_method":"DELETE","short_description":"Deletes an OVAL content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_contents/sync","name":"sync","apis":[{"api_url":"/api/compliance/oval_contents/sync","http_method":"POST","short_description":"Sync contents that have remote source URL","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"oval_policies":{"doc_url":"/apidoc/v2/oval_policies","id":"oval_policies","api_url":"/api","name":"Oval_policies","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/oval_policies/index","name":"index","apis":[{"api_url":"/api/compliance/oval_policies","http_method":"GET","short_description":"List OVAL Policies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_policies/show","name":"show","apis":[{"api_url":"/api/compliance/oval_policies/:id","http_method":"GET","short_description":"Show an OVAL Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_policies/create","name":"create","apis":[{"api_url":"/api/compliance/oval_policies","http_method":"POST","short_description":"Create an OVAL Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"oval_policy","full_name":"oval_policy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"oval_policy[name]","description":"\n\u003cp\u003eOVAL Policy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"oval_content_id","full_name":"oval_policy[oval_content_id]","description":"\n\u003cp\u003ePolicy OVAL content ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"oval_policy[description]","description":"\n\u003cp\u003eOVAL Policy description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"period","full_name":"oval_policy[period]","description":"\n\u003cp\u003eOVAL Policy schedule period (weekly, monthly, custom)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"weekday","full_name":"oval_policy[weekday]","description":"\n\u003cp\u003eOVAL Policy schedule weekday (only if period == “weekly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"day_of_month","full_name":"oval_policy[day_of_month]","description":"\n\u003cp\u003eOVAL Policy schedule day of month (only if period == “monthly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cron_line","full_name":"oval_policy[cron_line]","description":"\n\u003cp\u003eOVAL Policy schedule cron line (only if period == “custom”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"oval_policy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"oval_policy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_policies/update","name":"update","apis":[{"api_url":"/api/compliance/oval_policies/:id","http_method":"PUT","short_description":"Update an OVAL Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"oval_policy","full_name":"oval_policy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"oval_policy[name]","description":"\n\u003cp\u003eOVAL Policy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"oval_content_id","full_name":"oval_policy[oval_content_id]","description":"\n\u003cp\u003ePolicy OVAL content ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"oval_policy[description]","description":"\n\u003cp\u003eOVAL Policy description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"period","full_name":"oval_policy[period]","description":"\n\u003cp\u003eOVAL Policy schedule period (weekly, monthly, custom)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"weekday","full_name":"oval_policy[weekday]","description":"\n\u003cp\u003eOVAL Policy schedule weekday (only if period == “weekly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"day_of_month","full_name":"oval_policy[day_of_month]","description":"\n\u003cp\u003eOVAL Policy schedule day of month (only if period == “monthly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cron_line","full_name":"oval_policy[cron_line]","description":"\n\u003cp\u003eOVAL Policy schedule cron line (only if period == “custom”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"oval_policy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"oval_policy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_policies/destroy","name":"destroy","apis":[{"api_url":"/api/compliance/oval_policies/:id","http_method":"DELETE","short_description":"Delete an OVAL Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_policies/assign_hostgroups","name":"assign_hostgroups","apis":[{"api_url":"/api/compliance/oval_policies/:id/assign_hostgroups","http_method":"POST","short_description":"Assign hostgroups to an OVAL Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_ids","full_name":"hostgroup_ids","description":"\n\u003cp\u003eArray of hostgroup IDs\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_policies/assign_hosts","name":"assign_hosts","apis":[{"api_url":"/api/compliance/oval_policies/:id/assign_hosts","http_method":"POST","short_description":"Assign hosts to an OVAL Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host IDs\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/oval_policies/oval_content","name":"oval_content","apis":[{"api_url":"/api/compliance/oval_policies/:id/oval_content","http_method":"GET","short_description":"Show a policy's OVAL content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"oval_reports":{"doc_url":"/apidoc/v2/oval_reports","id":"oval_reports","api_url":"/api","name":"Oval_reports","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/oval_reports/create","name":"create","apis":[{"api_url":"/api/compliance/oval_reports/:cname/:oval_policy_id/:date","http_method":"POST","short_description":"Upload an OVAL report - a list of CVEs for given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cname","full_name":"cname","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"oval_policy_id","full_name":"oval_policy_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date","full_name":"date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"policies":{"doc_url":"/apidoc/v2/policies","id":"policies","api_url":"/api","name":"Policies","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/policies/index","name":"index","apis":[{"api_url":"/api/compliance/policies","http_method":"GET","short_description":"List Policies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"profile","type":"string"},{"name":"tailoring_file","type":"string"},{"name":"tailoring_file_profile","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/policies/show","name":"show","apis":[{"api_url":"/api/compliance/policies/:id","http_method":"GET","short_description":"Show a Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/policies/create","name":"create","apis":[{"api_url":"/api/compliance/policies","http_method":"POST","short_description":"Create a Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"policy","full_name":"policy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"policy[name]","description":"\n\u003cp\u003ePolicy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"policy[description]","description":"\n\u003cp\u003ePolicy description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_content_id","full_name":"policy[scap_content_id]","description":"\n\u003cp\u003ePolicy SCAP content ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_content_profile_id","full_name":"policy[scap_content_profile_id]","description":"\n\u003cp\u003ePolicy SCAP content profile ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"period","full_name":"policy[period]","description":"\n\u003cp\u003ePolicy schedule period (weekly, monthly, custom)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"weekday","full_name":"policy[weekday]","description":"\n\u003cp\u003ePolicy schedule weekday (only if period == “weekly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"day_of_month","full_name":"policy[day_of_month]","description":"\n\u003cp\u003ePolicy schedule day of month (only if period == “monthly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cron_line","full_name":"policy[cron_line]","description":"\n\u003cp\u003ePolicy schedule cron line (only if period == “custom”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_ids","full_name":"policy[hostgroup_ids]","description":"\n\u003cp\u003eApply policy to host groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"policy[host_ids]","description":"\n\u003cp\u003eApply policy to hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tailoring_file_id","full_name":"policy[tailoring_file_id]","description":"\n\u003cp\u003eTailoring file ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tailoring_file_profile_id","full_name":"policy[tailoring_file_profile_id]","description":"\n\u003cp\u003eTailoring file profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deploy_by","full_name":"policy[deploy_by]","description":"\n\u003cp\u003eHow the policy should be deployed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eansible\u003c/code\u003e, \u003ccode\u003emanual\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"policy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"policy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/policies/update","name":"update","apis":[{"api_url":"/api/compliance/policies/:id","http_method":"PUT","short_description":"Update a Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"policy","full_name":"policy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"policy[name]","description":"\n\u003cp\u003ePolicy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"policy[description]","description":"\n\u003cp\u003ePolicy description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_content_id","full_name":"policy[scap_content_id]","description":"\n\u003cp\u003ePolicy SCAP content ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_content_profile_id","full_name":"policy[scap_content_profile_id]","description":"\n\u003cp\u003ePolicy SCAP content profile ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"period","full_name":"policy[period]","description":"\n\u003cp\u003ePolicy schedule period (weekly, monthly, custom)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"weekday","full_name":"policy[weekday]","description":"\n\u003cp\u003ePolicy schedule weekday (only if period == “weekly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"day_of_month","full_name":"policy[day_of_month]","description":"\n\u003cp\u003ePolicy schedule day of month (only if period == “monthly”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cron_line","full_name":"policy[cron_line]","description":"\n\u003cp\u003ePolicy schedule cron line (only if period == “custom”)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_ids","full_name":"policy[hostgroup_ids]","description":"\n\u003cp\u003eApply policy to host groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"policy[host_ids]","description":"\n\u003cp\u003eApply policy to hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tailoring_file_id","full_name":"policy[tailoring_file_id]","description":"\n\u003cp\u003eTailoring file ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tailoring_file_profile_id","full_name":"policy[tailoring_file_profile_id]","description":"\n\u003cp\u003eTailoring file profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deploy_by","full_name":"policy[deploy_by]","description":"\n\u003cp\u003eHow the policy should be deployed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eansible\u003c/code\u003e, \u003ccode\u003emanual\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"policy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"policy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/policies/destroy","name":"destroy","apis":[{"api_url":"/api/compliance/policies/:id","http_method":"DELETE","short_description":"Delete a Policy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/policies/content","name":"content","apis":[{"api_url":"/api/compliance/policies/:id/content","http_method":"GET","short_description":"Show a policy's SCAP content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/policies/tailoring","name":"tailoring","apis":[{"api_url":"/api/compliance/policies/:id/tailoring","http_method":"GET","short_description":"Show a policy's Tailoring file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"scap_content_profiles":{"doc_url":"/apidoc/v2/scap_content_profiles","id":"scap_content_profiles","api_url":"/api","name":"Scap_content_profiles","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/scap_content_profiles/index","name":"index","apis":[{"api_url":"/api/compliance/scap_content_profiles","http_method":"GET","short_description":"List SCAP content profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"profile_id","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"scap_contents":{"doc_url":"/apidoc/v2/scap_contents","id":"scap_contents","api_url":"/api","name":"Scap_contents","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/scap_contents/index","name":"index","apis":[{"api_url":"/api/compliance/scap_contents","http_method":"GET","short_description":"List SCAP contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"created_at","type":"datetime"},{"name":"filename","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/scap_contents/xml","name":"xml","apis":[{"api_url":"/api/compliance/scap_contents/:id/xml","http_method":"GET","short_description":"Download an SCAP content as XML","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/scap_contents/show","name":"show","apis":[{"api_url":"/api/compliance/scap_contents/:id","http_method":"GET","short_description":"Show an SCAP content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/scap_contents/create","name":"create","apis":[{"api_url":"/api/compliance/scap_contents","http_method":"POST","short_description":"Create SCAP content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_content","full_name":"scap_content","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"title","full_name":"scap_content[title]","description":"\n\u003cp\u003eSCAP content name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_file","full_name":"scap_content[scap_file]","description":"\n\u003cp\u003eXML containing SCAP content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_filename","full_name":"scap_content[original_filename]","description":"\n\u003cp\u003eOriginal file name of the XML file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"scap_content[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"scap_content[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/scap_contents/update","name":"update","apis":[{"api_url":"/api/compliance/scap_contents/:id","http_method":"PUT","short_description":"Update an SCAP content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_content","full_name":"scap_content","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"title","full_name":"scap_content[title]","description":"\n\u003cp\u003eSCAP content name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_file","full_name":"scap_content[scap_file]","description":"\n\u003cp\u003eXML containing SCAP content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_filename","full_name":"scap_content[original_filename]","description":"\n\u003cp\u003eOriginal file name of the XML file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"scap_content[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"scap_content[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/scap_contents/destroy","name":"destroy","apis":[{"api_url":"/api/compliance/scap_contents/:id","http_method":"DELETE","short_description":"Deletes an SCAP content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/scap_contents/bulk_upload","name":"bulk_upload","apis":[{"api_url":"/api/compliance/scap_contents/bulk_upload","http_method":"POST","short_description":"Upload scap contents in bulk","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n\u003cp\u003eType of the upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efiles\u003c/code\u003e, \u003ccode\u003edirectory\u003c/code\u003e, \u003ccode\u003edefault\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"files","full_name":"files","description":"\n\u003cp\u003eFile paths to upload when using “files” upload type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"directory","full_name":"directory","description":"\n\u003cp\u003eDirectory to upload when using “directory” upload type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"tailoring_files":{"doc_url":"/apidoc/v2/tailoring_files","id":"tailoring_files","api_url":"/api","name":"Tailoring_files","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/tailoring_files/index","name":"index","apis":[{"api_url":"/api/compliance/tailoring_files","http_method":"GET","short_description":"List Tailoring files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"created_at","type":"datetime"},{"name":"filename","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/tailoring_files/xml","name":"xml","apis":[{"api_url":"/api/compliance/tailoring_files/:id/xml","http_method":"GET","short_description":"Download a Tailoring file as XML","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/tailoring_files/show","name":"show","apis":[{"api_url":"/api/compliance/tailoring_files/:id","http_method":"GET","short_description":"Show a Tailoring file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/tailoring_files/create","name":"create","apis":[{"api_url":"/api/compliance/tailoring_files","http_method":"POST","short_description":"Create a Tailoring file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tailoring_file","full_name":"tailoring_file","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"tailoring_file[name]","description":"\n\u003cp\u003eTailoring file name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_file","full_name":"tailoring_file[scap_file]","description":"\n\u003cp\u003eXML containing tailoring file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_filename","full_name":"tailoring_file[original_filename]","description":"\n\u003cp\u003eOriginal file name of the XML file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"tailoring_file[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"tailoring_file[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/tailoring_files/update","name":"update","apis":[{"api_url":"/api/compliance/tailoring_files/:id","http_method":"PUT","short_description":"Update a Tailoring file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tailoring_file","full_name":"tailoring_file","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"tailoring_file[name]","description":"\n\u003cp\u003eTailoring file name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scap_file","full_name":"tailoring_file[scap_file]","description":"\n\u003cp\u003eXML containing tailoring file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_filename","full_name":"tailoring_file[original_filename]","description":"\n\u003cp\u003eOriginal file name of the XML file\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"tailoring_file[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"tailoring_file[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/tailoring_files/destroy","name":"destroy","apis":[{"api_url":"/api/compliance/tailoring_files/:id","http_method":"DELETE","short_description":"Deletes a Tailoring file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"templates":{"doc_url":"/apidoc/v2/templates","id":"templates","api_url":"/api","name":"Templates","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/templates/import","name":"import","apis":[{"api_url":"/api/templates/import","http_method":"POST","short_description":"Initiate Import","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prefix","full_name":"prefix","description":"\n\u003cp\u003eThe string all imported templates should begin with.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"associate","full_name":"associate","description":"\n\u003cp\u003eAssociate to OS\u0026#39;s, Locations \u0026amp; Organizations. Options are: always, new or never.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force","full_name":"force","description":"\n\u003cp\u003eUpdate templates that are locked\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lock","full_name":"lock","description":"\n\u003cp\u003eLock imported templates\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elock\u003c/code\u003e, \u003ccode\u003ekeep_lock_new\u003c/code\u003e, \u003ccode\u003ekeep\u003c/code\u003e, \u003ccode\u003eunlock\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"verbose","full_name":"verbose","description":"\n\u003cp\u003eShow template diff in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"branch","full_name":"branch","description":"\n\u003cp\u003eBranch in Git repo.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repo","full_name":"repo","description":"\n\u003cp\u003eOverride the default repo from settings.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eExport templates with names matching this regex (case-insensitive; snippets are not filtered).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"negate","full_name":"negate","description":"\n\u003cp\u003eNegate the prefix (for purging).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dirname","full_name":"dirname","description":"\n\u003cp\u003eThe directory within Git repo containing the templates\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"location_ids","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"organization_ids","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/templates/export","name":"export","apis":[{"api_url":"/api/templates/export","http_method":"POST","short_description":"Initiate Export","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"metadata_export_mode","full_name":"metadata_export_mode","description":"\n\u003cp\u003eSpecify how to handle metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003erefresh\u003c/code\u003e, \u003ccode\u003ekeep\u003c/code\u003e, \u003ccode\u003eremove\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"commit_msg","full_name":"commit_msg","description":"\n\u003cp\u003eCustom commit message for templates export\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"branch","full_name":"branch","description":"\n\u003cp\u003eBranch in Git repo.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"repo","full_name":"repo","description":"\n\u003cp\u003eOverride the default repo from settings.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eExport templates with names matching this regex (case-insensitive; snippets are not filtered).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"negate","full_name":"negate","description":"\n\u003cp\u003eNegate the prefix (for purging).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dirname","full_name":"dirname","description":"\n\u003cp\u003eThe directory within Git repo containing the templates\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"location_ids","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"organization_ids","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"configs":{"doc_url":"/apidoc/v2/configs","id":"configs","api_url":"/api","name":"Configs","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/configs/index","name":"index","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs","http_method":"GET","short_description":"List of virt-who configurations","deprecated":null},{"api_url":"/foreman_virt_who_configure/api/v2/organizations/:organization_id/configs","http_method":"GET","short_description":"List of virt-who configurations per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/configs/show","name":"show","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs/:id","http_method":"GET","short_description":"Show a virt-who configuration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/configs/deploy_script","name":"deploy_script","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs/:id/deploy_script","http_method":"GET","short_description":"Renders a deploy script for the specified virt-who configuration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/configs/create","name":"create","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs","http_method":"POST","short_description":"Create a virt-who configuration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"foreman_virt_who_configure_config","full_name":"foreman_virt_who_configure_config","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"foreman_virt_who_configure_config[name]","description":"\n\u003cp\u003eConfiguration name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interval","full_name":"foreman_virt_who_configure_config[interval]","description":"\n\u003cp\u003eConfiguration interval in minutes\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e60\u003c/code\u003e, \u003ccode\u003e120\u003c/code\u003e, \u003ccode\u003e240\u003c/code\u003e, \u003ccode\u003e480\u003c/code\u003e, \u003ccode\u003e720\u003c/code\u003e, \u003ccode\u003e1440\u003c/code\u003e, \u003ccode\u003e2880\u003c/code\u003e, \u003ccode\u003e4320\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filtering_mode","full_name":"foreman_virt_who_configure_config[filtering_mode]","description":"\n\u003cp\u003eHypervisor filtering mode, 0 means no filtering, 1 means whitelist, 2 means blacklist\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e2\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whitelist","full_name":"foreman_virt_who_configure_config[whitelist]","description":"\n\u003cp\u003eHypervisor whitelist, applicable only when filtering mode is set to 1. Wildcards and regular expressions are supported, multiple records must be separated by comma.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blacklist","full_name":"foreman_virt_who_configure_config[blacklist]","description":"\n\u003cp\u003eHypervisor blacklist, applicable only when filtering mode is set to 2. Wildcards and regular expressions are supported, multiple records must be separated by comma.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_host_parents","full_name":"foreman_virt_who_configure_config[filter_host_parents]","description":"\n\u003cp\u003eApplicable only for esx provider type. Only hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude_host_parents","full_name":"foreman_virt_who_configure_config[exclude_host_parents]","description":"\n\u003cp\u003eApplicable only for esx provider type. Hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will \u003cstrong\u003eNOT\u003c/strong\u003e be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_id","full_name":"foreman_virt_who_configure_config[hypervisor_id]","description":"\n\u003cp\u003eSpecifies how the hypervisor will be identified.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehostname\u003c/code\u003e, \u003ccode\u003euuid\u003c/code\u003e, \u003ccode\u003ehwuuid\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_type","full_name":"foreman_virt_who_configure_config[hypervisor_type]","description":"\n\u003cp\u003eHypervisor type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eesx\u003c/code\u003e, \u003ccode\u003ehyperv\u003c/code\u003e, \u003ccode\u003elibvirt\u003c/code\u003e, \u003ccode\u003ekubevirt\u003c/code\u003e, \u003ccode\u003eahv\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_server","full_name":"foreman_virt_who_configure_config[hypervisor_server]","description":"\n\u003cp\u003eFully qualified host name or IP address of the hypervisor\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_username","full_name":"foreman_virt_who_configure_config[hypervisor_username]","description":"\n\u003cp\u003eAccount name by which virt-who is to connect to the hypervisor.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_password","full_name":"foreman_virt_who_configure_config[hypervisor_password]","description":"\n\u003cp\u003eHypervisor password, required for all hypervisor types except for libvirt/kubevirt.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"satellite_url","full_name":"foreman_virt_who_configure_config[satellite_url]","description":"\n\u003cp\u003eForeman server FQDN\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"debug","full_name":"foreman_virt_who_configure_config[debug]","description":"\n\u003cp\u003eEnable debugging output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kubeconfig_path","full_name":"foreman_virt_who_configure_config[kubeconfig_path]","description":"\n\u003cp\u003eConfiguration file containing details about how to connect to the cluster and authentication details.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy_id","full_name":"foreman_virt_who_configure_config[http_proxy_id]","description":"\n\u003cp\u003eHTTP proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_proxy","full_name":"foreman_virt_who_configure_config[no_proxy]","description":"\n\u003cp\u003eIgnore proxy. A comma-separated list of hostnames or domains or ip addresses to ignore proxy settings for. Optionally this may be set to * to bypass proxy settings for all hostnames domains or ip addresses.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"foreman_virt_who_configure_config[organization_id]","description":"\n\u003cp\u003eOrganization of the virt-who configuration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prism_flavor","full_name":"foreman_virt_who_configure_config[prism_flavor]","description":"\n\u003cp\u003eSelect the Prism flavor you are connecting to\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecentral\u003c/code\u003e, \u003ccode\u003eelement\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ahv_internal_debug","full_name":"foreman_virt_who_configure_config[ahv_internal_debug]","description":"\n\u003cp\u003eOption Enable debugging output is required to enable AHV internal debug. It provides extra AHV debug information when both options are enabled\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/configs/update","name":"update","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs/:id","http_method":"PUT","short_description":"Update a virt-who configuration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eConfiguration numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"foreman_virt_who_configure_config","full_name":"foreman_virt_who_configure_config","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"foreman_virt_who_configure_config[name]","description":"\n\u003cp\u003eConfiguration name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interval","full_name":"foreman_virt_who_configure_config[interval]","description":"\n\u003cp\u003eConfiguration interval in minutes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e60\u003c/code\u003e, \u003ccode\u003e120\u003c/code\u003e, \u003ccode\u003e240\u003c/code\u003e, \u003ccode\u003e480\u003c/code\u003e, \u003ccode\u003e720\u003c/code\u003e, \u003ccode\u003e1440\u003c/code\u003e, \u003ccode\u003e2880\u003c/code\u003e, \u003ccode\u003e4320\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filtering_mode","full_name":"foreman_virt_who_configure_config[filtering_mode]","description":"\n\u003cp\u003eHypervisor filtering mode, 0 means no filtering, 1 means whitelist, 2 means blacklist\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e2\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whitelist","full_name":"foreman_virt_who_configure_config[whitelist]","description":"\n\u003cp\u003eHypervisor whitelist, applicable only when filtering mode is set to 1. Wildcards and regular expressions are supported, multiple records must be separated by comma.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blacklist","full_name":"foreman_virt_who_configure_config[blacklist]","description":"\n\u003cp\u003eHypervisor blacklist, applicable only when filtering mode is set to 2. Wildcards and regular expressions are supported, multiple records must be separated by comma.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_host_parents","full_name":"foreman_virt_who_configure_config[filter_host_parents]","description":"\n\u003cp\u003eApplicable only for esx provider type. Only hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude_host_parents","full_name":"foreman_virt_who_configure_config[exclude_host_parents]","description":"\n\u003cp\u003eApplicable only for esx provider type. Hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will \u003cstrong\u003eNOT\u003c/strong\u003e be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_id","full_name":"foreman_virt_who_configure_config[hypervisor_id]","description":"\n\u003cp\u003eSpecifies how the hypervisor will be identified.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehostname\u003c/code\u003e, \u003ccode\u003euuid\u003c/code\u003e, \u003ccode\u003ehwuuid\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_type","full_name":"foreman_virt_who_configure_config[hypervisor_type]","description":"\n\u003cp\u003eHypervisor type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eesx\u003c/code\u003e, \u003ccode\u003ehyperv\u003c/code\u003e, \u003ccode\u003elibvirt\u003c/code\u003e, \u003ccode\u003ekubevirt\u003c/code\u003e, \u003ccode\u003eahv\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_server","full_name":"foreman_virt_who_configure_config[hypervisor_server]","description":"\n\u003cp\u003eFully qualified host name or IP address of the hypervisor\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_username","full_name":"foreman_virt_who_configure_config[hypervisor_username]","description":"\n\u003cp\u003eAccount name by which virt-who is to connect to the hypervisor.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hypervisor_password","full_name":"foreman_virt_who_configure_config[hypervisor_password]","description":"\n\u003cp\u003eHypervisor password, required for all hypervisor types except for libvirt/kubevirt.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"satellite_url","full_name":"foreman_virt_who_configure_config[satellite_url]","description":"\n\u003cp\u003eForeman server FQDN\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"debug","full_name":"foreman_virt_who_configure_config[debug]","description":"\n\u003cp\u003eEnable debugging output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kubeconfig_path","full_name":"foreman_virt_who_configure_config[kubeconfig_path]","description":"\n\u003cp\u003eConfiguration file containing details about how to connect to the cluster and authentication details.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy_id","full_name":"foreman_virt_who_configure_config[http_proxy_id]","description":"\n\u003cp\u003eHTTP proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_proxy","full_name":"foreman_virt_who_configure_config[no_proxy]","description":"\n\u003cp\u003eIgnore proxy. A comma-separated list of hostnames or domains or ip addresses to ignore proxy settings for. Optionally this may be set to * to bypass proxy settings for all hostnames domains or ip addresses.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"foreman_virt_who_configure_config[organization_id]","description":"\n\u003cp\u003eOrganization of the virt-who configuration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prism_flavor","full_name":"foreman_virt_who_configure_config[prism_flavor]","description":"\n\u003cp\u003eSelect the Prism flavor you are connecting to\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecentral\u003c/code\u003e, \u003ccode\u003eelement\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ahv_internal_debug","full_name":"foreman_virt_who_configure_config[ahv_internal_debug]","description":"\n\u003cp\u003eOption Enable debugging output is required to enable AHV internal debug. It provides extra AHV debug information when both options are enabled\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/configs/destroy","name":"destroy","apis":[{"api_url":"/foreman_virt_who_configure/api/v2/configs/:id","http_method":"DELETE","short_description":"Delete a virt-who configuration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eConfiguration numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"preupgrade_reports":{"doc_url":"/apidoc/v2/preupgrade_reports","id":"preupgrade_reports","api_url":"/api","name":"Preupgrade_reports","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/preupgrade_reports/index","name":"index","apis":[{"api_url":"/api/preupgrade_reports","http_method":"GET","short_description":"List Preupgrade reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/preupgrade_reports/show","name":"show","apis":[{"api_url":"/api/preupgrade_reports/:id","http_method":"GET","short_description":"Show Preupgrade report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/preupgrade_reports/job_invocation","name":"job_invocation","apis":[{"api_url":"/api/job_invocations/:id/preupgrade_reports","http_method":"GET","short_description":"List Preupgrade reports for Job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"inventory":{"doc_url":"/apidoc/v2/inventory","id":"inventory","api_url":"/api","name":"Inventory","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/inventory/download_file","name":"download_file","apis":[{"api_url":"/api/organizations/:organization_id/rh_cloud/report","http_method":"GET","short_description":"Download latest report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/inventory/generate_report","name":"generate_report","apis":[{"api_url":"/api/organizations/:organization_id/rh_cloud/report","http_method":"POST","short_description":"Start report generation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"disconnected","full_name":"disconnected","description":"\n\u003cp\u003eGenerate the report, but do not upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/inventory/get_hosts","name":"get_hosts","apis":[{"api_url":"/api/organizations/:organization_id/rh_cloud/missing_hosts","http_method":"GET","short_description":"Grab hosts that are missing in RH Cloud","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/inventory/remove_hosts","name":"remove_hosts","apis":[{"api_url":"/api/organizations/:organization_id/rh_cloud/missing_hosts","http_method":"POST","short_description":"Grab hosts that are missing in RH Cloud","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search_term","full_name":"search_term","description":"\n\u003cp\u003eScoped search string for host removal\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/inventory/sync_inventory_status","name":"sync_inventory_status","apis":[{"api_url":"/api/organizations/:organization_id/rh_cloud/inventory_sync","http_method":"POST","short_description":"Start inventory synchronization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/inventory/enable_cloud_connector","name":"enable_cloud_connector","apis":[{"api_url":"/api/rh_cloud/enable_connector","http_method":"POST","short_description":"Enable cloud connector","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"webhook_templates":{"doc_url":"/apidoc/v2/webhook_templates","id":"webhook_templates","api_url":"/api","name":"Webhook_templates","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/webhook_templates/index","name":"index","apis":[{"api_url":"/api/webhook_templates","http_method":"GET","short_description":"List webhook templates","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhook_templates/show","name":"show","apis":[{"api_url":"/api/webhook_templates/:id","http_method":"GET","short_description":"Show webhook template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhook_templates/create","name":"create","apis":[{"api_url":"/api/webhook_templates","http_method":"POST","short_description":"Create a webhook template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_template","full_name":"webhook_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"webhook_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"webhook_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"webhook_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"snippet","full_name":"webhook_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audit_comment","full_name":"webhook_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locked","full_name":"webhook_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default","full_name":"webhook_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and locations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"webhook_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"webhook_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhook_templates/import","name":"import","apis":[{"api_url":"/api/webhook_templates/import","http_method":"POST","short_description":"Import a webhook template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_template","full_name":"webhook_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"webhook_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"webhook_template[template]","description":"\n\u003cp\u003eTemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"webhook_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"webhook_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhook_templates/update","name":"update","apis":[{"api_url":"/api/webhook_templates/:id","http_method":"PUT","short_description":"Update a webhook template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_template","full_name":"webhook_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"webhook_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"webhook_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"webhook_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"snippet","full_name":"webhook_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audit_comment","full_name":"webhook_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locked","full_name":"webhook_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default","full_name":"webhook_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and locations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"webhook_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"webhook_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhook_templates/destroy","name":"destroy","apis":[{"api_url":"/api/webhook_templates/:id","http_method":"DELETE","short_description":"Delete a webhook template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhook_templates/clone","name":"clone","apis":[{"api_url":"/api/webhook_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_template","full_name":"webhook_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"webhook_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhook_templates/export","name":"export","apis":[{"api_url":"/api/webhook_templates/:id/export","http_method":"GET","short_description":"Export a webhook template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"webhooks":{"doc_url":"/apidoc/v2/webhooks","id":"webhooks","api_url":"/api","name":"Webhooks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/webhooks/index","name":"index","apis":[{"api_url":"/api/webhooks","http_method":"GET","short_description":"List Webhooks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"enabled","values":["true","false"]},{"name":"name","type":"string"},{"name":"target_url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhooks/show","name":"show","apis":[{"api_url":"/api/webhooks/:id","http_method":"GET","short_description":"Show Webhook details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhooks/create","name":"create","apis":[{"api_url":"/api/webhooks","http_method":"POST","short_description":"Create a Webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook","full_name":"webhook","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"webhook[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"target_url","full_name":"webhook[target_url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_method","full_name":"webhook[http_method]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ePOST\u003c/code\u003e, \u003ccode\u003eGET\u003c/code\u003e, \u003ccode\u003ePUT\u003c/code\u003e, \u003ccode\u003eDELETE\u003c/code\u003e, \u003ccode\u003ePATCH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_content_type","full_name":"webhook[http_content_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"event","full_name":"webhook[event]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactions.katello.capsule_content.sync_failed\u003c/code\u003e, \u003ccode\u003eactions.katello.capsule_content.sync_succeeded\u003c/code\u003e, \u003ccode\u003eactions.katello.content_view.promote_failed\u003c/code\u003e, \u003ccode\u003eactions.katello.content_view.promote_succeeded\u003c/code\u003e, \u003ccode\u003eactions.katello.content_view.publish_failed\u003c/code\u003e, \u003ccode\u003eactions.katello.content_view.publish_succeeded\u003c/code\u003e, \u003ccode\u003eactions.katello.repository.sync_failed\u003c/code\u003e, \u003ccode\u003eactions.katello.repository.sync_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_configure_cloud_connector_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_configure_cloud_connector_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_enable_web_console_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_enable_web_console_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_capsule_upgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_capsule_upgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_host_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_host_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_insights_plan_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_insights_plan_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_playbook_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_playbook_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_foreman_openscap_run_oval_scans_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_foreman_openscap_run_oval_scans_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_foreman_openscap_run_scans_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_foreman_openscap_run_scans_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_errata_install_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_errata_install_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_errata_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_errata_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_remove_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_remove_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_update_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_update_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_host_tracer_resolve_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_host_tracer_resolve_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_module_stream_action_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_module_stream_action_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_install_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_install_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_remove_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_remove_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_update_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_update_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_packages_remove_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_packages_remove_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_packages_update_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_packages_update_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_service_restart_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_service_restart_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_preupgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_preupgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_remediation_plan_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_remediation_plan_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_upgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_upgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_puppet_run_host_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_puppet_run_host_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_rh_cloud_remediate_hosts_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_rh_cloud_remediate_hosts_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_run_script_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_run_script_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_enable_web_console_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_enable_web_console_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_enable_web_console_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_host_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_host_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_host_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_insights_plan_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_insights_plan_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_insights_plan_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_playbook_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_playbook_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_playbook_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_oval_scans_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_oval_scans_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_oval_scans_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_scans_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_scans_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_scans_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_by_search_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_install_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_remove_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_remove_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_remove_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_update_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_update_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_update_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_host_tracer_resolve_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_host_tracer_resolve_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_host_tracer_resolve_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_module_stream_action_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_module_stream_action_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_module_stream_action_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_by_search_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_remove_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_remove_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_remove_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_update_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_update_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_update_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_remove_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_remove_by_search_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_remove_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_update_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_update_by_search_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_update_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_service_restart_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_service_restart_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_service_restart_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_preupgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_preupgrade_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_preupgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_remediation_plan_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_remediation_plan_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_remediation_plan_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_upgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_upgrade_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_upgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_puppet_run_host_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_puppet_run_host_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_puppet_run_host_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_run_script_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_run_script_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_run_script_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_succeeded\u003c/code\u003e, \u003ccode\u003ebuild_entered\u003c/code\u003e, \u003ccode\u003ebuild_exited\u003c/code\u003e, \u003ccode\u003econtent_view_created\u003c/code\u003e, \u003ccode\u003econtent_view_destroyed\u003c/code\u003e, \u003ccode\u003econtent_view_updated\u003c/code\u003e, \u003ccode\u003edomain_created\u003c/code\u003e, \u003ccode\u003edomain_destroyed\u003c/code\u003e, \u003ccode\u003edomain_updated\u003c/code\u003e, \u003ccode\u003ehost_created\u003c/code\u003e, \u003ccode\u003ehost_destroyed\u003c/code\u003e, \u003ccode\u003ehost_facts_updated\u003c/code\u003e, \u003ccode\u003ehost_updated\u003c/code\u003e, \u003ccode\u003ehostgroup_created\u003c/code\u003e, \u003ccode\u003ehostgroup_destroyed\u003c/code\u003e, \u003ccode\u003ehostgroup_updated\u003c/code\u003e, \u003ccode\u003emodel_created\u003c/code\u003e, \u003ccode\u003emodel_destroyed\u003c/code\u003e, \u003ccode\u003emodel_updated\u003c/code\u003e, \u003ccode\u003estatus_changed\u003c/code\u003e, \u003ccode\u003esubnet_created\u003c/code\u003e, \u003ccode\u003esubnet_destroyed\u003c/code\u003e, \u003ccode\u003esubnet_updated\u003c/code\u003e, \u003ccode\u003euser_created\u003c/code\u003e, \u003ccode\u003euser_destroyed\u003c/code\u003e, \u003ccode\u003euser_updated\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_template_id","full_name":"webhook[webhook_template_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"webhook[enabled]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"verify_ssl","full_name":"webhook[verify_ssl]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_ca_certs","full_name":"webhook[ssl_ca_certs]","description":"\n\u003cp\u003eX509 Certification Authorities concatenated in PEM format\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user","full_name":"webhook[user]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"webhook[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_headers","full_name":"webhook[http_headers]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"proxy_authorization","full_name":"webhook[proxy_authorization]","description":"\n\u003cp\u003eAuthorize with Foreman client certificate and validate smart-proxy CA from Settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhooks/update","name":"update","apis":[{"api_url":"/api/webhooks/:id","http_method":"PUT","short_description":"Update a Webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook","full_name":"webhook","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"webhook[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"target_url","full_name":"webhook[target_url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_method","full_name":"webhook[http_method]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ePOST\u003c/code\u003e, \u003ccode\u003eGET\u003c/code\u003e, \u003ccode\u003ePUT\u003c/code\u003e, \u003ccode\u003eDELETE\u003c/code\u003e, \u003ccode\u003ePATCH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_content_type","full_name":"webhook[http_content_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"event","full_name":"webhook[event]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactions.katello.capsule_content.sync_failed\u003c/code\u003e, \u003ccode\u003eactions.katello.capsule_content.sync_succeeded\u003c/code\u003e, \u003ccode\u003eactions.katello.content_view.promote_failed\u003c/code\u003e, \u003ccode\u003eactions.katello.content_view.promote_succeeded\u003c/code\u003e, \u003ccode\u003eactions.katello.content_view.publish_failed\u003c/code\u003e, \u003ccode\u003eactions.katello.content_view.publish_succeeded\u003c/code\u003e, \u003ccode\u003eactions.katello.repository.sync_failed\u003c/code\u003e, \u003ccode\u003eactions.katello.repository.sync_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_configure_cloud_connector_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_configure_cloud_connector_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_enable_web_console_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_enable_web_console_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_capsule_upgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_capsule_upgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_host_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_host_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_insights_plan_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_insights_plan_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_playbook_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_ansible_run_playbook_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_foreman_openscap_run_oval_scans_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_foreman_openscap_run_oval_scans_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_foreman_openscap_run_scans_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_foreman_openscap_run_scans_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_errata_install_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_errata_install_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_errata_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_errata_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_remove_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_remove_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_update_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_group_update_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_host_tracer_resolve_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_host_tracer_resolve_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_module_stream_action_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_module_stream_action_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_install_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_install_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_remove_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_remove_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_update_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_package_update_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_packages_remove_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_packages_remove_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_packages_update_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_packages_update_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_service_restart_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_katello_service_restart_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_preupgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_preupgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_remediation_plan_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_remediation_plan_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_upgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_leapp_upgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_puppet_run_host_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_puppet_run_host_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_rh_cloud_remediate_hosts_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_rh_cloud_remediate_hosts_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_run_script_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_run_script_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_host_job_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_enable_web_console_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_enable_web_console_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_enable_web_console_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_host_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_host_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_host_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_insights_plan_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_insights_plan_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_insights_plan_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_playbook_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_playbook_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_ansible_run_playbook_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_oval_scans_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_oval_scans_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_oval_scans_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_scans_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_scans_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_foreman_openscap_run_scans_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_by_search_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_errata_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_install_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_remove_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_remove_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_remove_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_update_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_update_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_group_update_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_host_tracer_resolve_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_host_tracer_resolve_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_host_tracer_resolve_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_module_stream_action_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_module_stream_action_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_module_stream_action_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_by_search_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_install_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_remove_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_remove_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_remove_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_update_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_update_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_package_update_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_remove_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_remove_by_search_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_remove_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_update_by_search_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_update_by_search_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_packages_update_by_search_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_service_restart_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_service_restart_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_katello_service_restart_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_preupgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_preupgrade_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_preupgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_remediation_plan_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_remediation_plan_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_remediation_plan_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_upgrade_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_upgrade_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_leapp_upgrade_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_puppet_run_host_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_puppet_run_host_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_puppet_run_host_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_run_script_failed\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_run_script_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_run_script_succeeded\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_running\u003c/code\u003e, \u003ccode\u003eactions.remote_execution.run_hosts_job_succeeded\u003c/code\u003e, \u003ccode\u003ebuild_entered\u003c/code\u003e, \u003ccode\u003ebuild_exited\u003c/code\u003e, \u003ccode\u003econtent_view_created\u003c/code\u003e, \u003ccode\u003econtent_view_destroyed\u003c/code\u003e, \u003ccode\u003econtent_view_updated\u003c/code\u003e, \u003ccode\u003edomain_created\u003c/code\u003e, \u003ccode\u003edomain_destroyed\u003c/code\u003e, \u003ccode\u003edomain_updated\u003c/code\u003e, \u003ccode\u003ehost_created\u003c/code\u003e, \u003ccode\u003ehost_destroyed\u003c/code\u003e, \u003ccode\u003ehost_facts_updated\u003c/code\u003e, \u003ccode\u003ehost_updated\u003c/code\u003e, \u003ccode\u003ehostgroup_created\u003c/code\u003e, \u003ccode\u003ehostgroup_destroyed\u003c/code\u003e, \u003ccode\u003ehostgroup_updated\u003c/code\u003e, \u003ccode\u003emodel_created\u003c/code\u003e, \u003ccode\u003emodel_destroyed\u003c/code\u003e, \u003ccode\u003emodel_updated\u003c/code\u003e, \u003ccode\u003estatus_changed\u003c/code\u003e, \u003ccode\u003esubnet_created\u003c/code\u003e, \u003ccode\u003esubnet_destroyed\u003c/code\u003e, \u003ccode\u003esubnet_updated\u003c/code\u003e, \u003ccode\u003euser_created\u003c/code\u003e, \u003ccode\u003euser_destroyed\u003c/code\u003e, \u003ccode\u003euser_updated\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_template_id","full_name":"webhook[webhook_template_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"webhook[enabled]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"verify_ssl","full_name":"webhook[verify_ssl]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssl_ca_certs","full_name":"webhook[ssl_ca_certs]","description":"\n\u003cp\u003eX509 Certification Authorities concatenated in PEM format\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user","full_name":"webhook[user]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"webhook[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_headers","full_name":"webhook[http_headers]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"proxy_authorization","full_name":"webhook[proxy_authorization]","description":"\n\u003cp\u003eAuthorize with Foreman client certificate and validate smart-proxy CA from Settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhooks/destroy","name":"destroy","apis":[{"api_url":"/api/webhooks/:id","http_method":"DELETE","short_description":"Delete a Webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhooks/events","name":"events","apis":[{"api_url":"/api/webhooks/events","http_method":"GET","short_description":"List available events for subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/webhooks/test","name":"test","apis":[{"api_url":"/api/webhooks/:id/test","http_method":"POST","short_description":"Test a Webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payload","full_name":"payload","description":"\n\u003cp\u003eTest payload will be sent as is. Cant be a JSON object\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"architectures":{"doc_url":"/apidoc/v2/architectures","id":"architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"audits":{"doc_url":"/apidoc/v2/audits","id":"audits","api_url":"/api","name":"Audits","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_externals":{"doc_url":"/apidoc/v2/auth_source_externals","id":"auth_source_externals","api_url":"/api","name":"Auth_source_externals","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/auth_source_externals/index","name":"index","apis":[{"api_url":"/api/auth_source_externals","http_method":"GET","short_description":"List external authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/auth_source_externals/show","name":"show","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"GET","short_description":"Show an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/auth_source_externals/update","name":"update","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"PUT","short_description":"Update an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_source_external","full_name":"auth_source_external","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"auth_source_external[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"auth_source_external[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"auth_source_external[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_internals":{"doc_url":"/apidoc/v2/auth_source_internals","id":"auth_source_internals","api_url":"/api","name":"Auth_source_internals","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/auth_source_internals/index","name":"index","apis":[{"api_url":"/api/auth_source_internals","http_method":"GET","short_description":"List internal authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/auth_source_internals/show","name":"show","apis":[{"api_url":"/api/auth_source_internals/:id","http_method":"GET","short_description":"Show an internal authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_ldaps":{"doc_url":"/apidoc/v2/auth_source_ldaps","id":"auth_source_ldaps","api_url":"/api","name":"Auth_source_ldaps","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/auth_source_ldaps/index","name":"index","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all LDAP authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/auth_source_ldaps/show","name":"show","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/auth_source_ldaps/create","name":"create","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"POST","short_description":"Create an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host","full_name":"auth_source_ldap[host]","description":"\n\u003cp\u003eThe hostname of the LDAP server\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/auth_source_ldaps/update","name":"update","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host","full_name":"auth_source_ldap[host]","description":"\n\u003cp\u003eThe hostname of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/auth_source_ldaps/destroy","name":"destroy","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_sources":{"doc_url":"/apidoc/v2/auth_sources","id":"auth_sources","api_url":"/api","name":"Auth_sources","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/auth_sources/index","name":"index","apis":[{"api_url":"/api/auth_sources","http_method":"GET","short_description":"List all authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"autosign":{"doc_url":"/apidoc/v2/autosign","id":"autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/autosign/create","name":"create","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"POST","short_description":"Create autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/autosign/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign/:id","http_method":"DELETE","short_description":"Delete autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bookmarks":{"doc_url":"/apidoc/v2/bookmarks","id":"bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"controller","type":"string"},{"name":"id","type":"integer"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/bookmarks/create","name":"create","apis":[{"api_url":"/api/bookmarks","http_method":"POST","short_description":"Create a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"common_parameters":{"doc_url":"/apidoc/v2/common_parameters","id":"common_parameters","api_url":"/api","name":"Common_parameters","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"id","type":"integer"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/common_parameters/create","name":"create","apis":[{"api_url":"/api/common_parameters","http_method":"POST","short_description":"Create a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_attributes":{"doc_url":"/apidoc/v2/compute_attributes","id":"compute_attributes","api_url":"/api","name":"Compute_attributes","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/compute_attributes/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute profile","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"List of compute attributes","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"\n\u003cp\u003eID of compute profile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute_resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compute_profile","type":"string"},{"name":"compute_resource","type":"string"},{"name":"id","type":"integer"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_attributes/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_profiles":{"doc_url":"/apidoc/v2/compute_profiles","id":"compute_profiles","api_url":"/api","name":"Compute_profiles","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_profiles/create","name":"create","apis":[{"api_url":"/api/compute_profiles","http_method":"POST","short_description":"Create a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_reports":{"doc_url":"/apidoc/v2/config_reports","id":"config_reports","api_url":"/api","name":"Config_reports","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"applied","type":"integer"},{"name":"eventful","values":["true","false"]},{"name":"failed","type":"integer"},{"name":"failed_restarts","type":"integer"},{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"host_owner_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"log","type":"text"},{"name":"organization","type":"string"},{"name":"origin","type":"string"},{"name":"pending","type":"integer"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"restarted","type":"integer"},{"name":"skipped","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/config_reports/create","name":"create","apis":[{"api_url":"/api/config_reports","http_method":"POST","short_description":"Create a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"/apidoc/v2/dashboard","id":"dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"domains":{"doc_url":"/apidoc/v2/domains","id":"domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman considers a domain and a DNS zone as the same thing. That is, if you are planning to manage a site where all the machines are of the form \u003cem\u003ehostname\u003c/em\u003e.\u003cstrong\u003esomewhere.com\u003c/strong\u003e then the domain is \u003cstrong\u003esomewhere.com\u003c/strong\u003e. This allows Foreman to associate a puppet variable with a domain/site and automatically append this variable to all external node requests made by machines at that site.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fullname","type":"string"},{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/domains/show","name":"show","apis":[{"api_url":"/api/domains/:id","http_method":"GET","short_description":"Show a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003efullname\u003c/strong\u003e field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"external_usergroups":{"doc_url":"/apidoc/v2/external_usergroups","id":"external_usergroups","api_url":"/api","name":"External_usergroups","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"filters":{"doc_url":"/apidoc/v2/filters","id":"filters","api_url":"/api","name":"Filters","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"limited","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"override","values":["true","false"]},{"name":"permission","type":"string"},{"name":"resource","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"search","type":"text"},{"name":"unlimited","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/filters/create","name":"create","apis":[{"api_url":"/api/filters","http_method":"POST","short_description":"Create a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"home":{"doc_url":"/apidoc/v2/home","id":"home","api_url":"/api","name":"Home","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_statuses":{"doc_url":"/apidoc/v2/host_statuses","id":"host_statuses","api_url":"/api","name":"Host_statuses","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/host_statuses/index","name":"index","apis":[{"api_url":"/api/host_statuses","http_method":"GET","short_description":"List of host statuses","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"http_proxies":{"doc_url":"/apidoc/v2/http_proxies","id":"http_proxies","api_url":"/api","name":"Http_proxies","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/http_proxies/index","name":"index","apis":[{"api_url":"/api/http_proxies","http_method":"GET","short_description":"List of HTTP Proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/http_proxies/show","name":"show","apis":[{"api_url":"/api/http_proxies/:id","http_method":"GET","short_description":"Show an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eIdentifier of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/http_proxies/create","name":"create","apis":[{"api_url":"/api/http_proxies","http_method":"POST","short_description":"Create an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/http_proxies/update","name":"update","apis":[{"api_url":"/api/http_proxies/:id","http_method":"PUT","short_description":"Update an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/http_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/http_proxies/:id","http_method":"DELETE","short_description":"Delete an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"images":{"doc_url":"/apidoc/v2/images","id":"images","api_url":"/api","name":"Images","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/images/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for a compute resource","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"integer"},{"name":"compute_resource","type":"string"},{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"operatingsystem","type":"integer"},{"name":"user_data","values":["true","false"]},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/images/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/images/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/images/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/images/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"instance_hosts":{"doc_url":"/apidoc/v2/instance_hosts","id":"instance_hosts","api_url":"/api","name":"Instance_hosts","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/instance_hosts/update","name":"update","apis":[{"api_url":"/api/instance_hosts/:host_id","http_method":"PUT","short_description":"Assign a host to the Foreman instance","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/instance_hosts/index","name":"index","apis":[{"api_url":"/api/instance_hosts","http_method":"GET","short_description":"List hosts forming the Foreman instance","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/instance_hosts/destroy","name":"destroy","apis":[{"api_url":"/api/instance_hosts/:host_id","http_method":"DESTROY","short_description":"Unassign a given host from the Foreman instance","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"/apidoc/v2/locations","id":"locations","api_url":"/api","name":"Locations","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/locations/show","name":"show","apis":[{"api_url":"/api/locations/:id","http_method":"GET","short_description":"Show a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/locations/create","name":"create","apis":[{"api_url":"/api/locations","http_method":"POST","short_description":"Create a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"mail_notifications":{"doc_url":"/apidoc/v2/mail_notifications","id":"mail_notifications","api_url":"/api","name":"Mail_notifications","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"user","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/mail_notifications/create","name":"create","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"POST","short_description":"Add an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/mail_notifications/update","name":"update","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"PUT","short_description":"Update an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/mail_notifications/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"DELETE","short_description":"Remove an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/mail_notifications/user_mail_notifications","name":"user_mail_notifications","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"GET","short_description":"List all email notifications for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"media":{"doc_url":"/apidoc/v2/media","id":"media","api_url":"/api","name":"Media","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"family","type":"string"},{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"path","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/media/create","name":"create","apis":[{"api_url":"/api/media","http_method":"POST","short_description":"Create a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca href=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e where $arch will be substituted for the host\u0026#39;s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca href=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e where $arch will be substituted for the host\u0026#39;s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"models":{"doc_url":"/apidoc/v2/models","id":"models","api_url":"/api","name":"Models","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"hardware_model","type":"string"},{"name":"id","type":"integer"},{"name":"info","type":"text"},{"name":"name","type":"string"},{"name":"vendor_class","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/models/create","name":"create","apis":[{"api_url":"/api/models","http_method":"POST","short_description":"Create a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operatingsystems":{"doc_url":"/apidoc/v2/operatingsystems","id":"operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_parameters_attributes","full_name":"os_parameters_attributes","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"os_parameters_attributes[name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"os_parameters_attributes[value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"description","type":"string"},{"name":"family","type":"string"},{"name":"id","type":"integer"},{"name":"major","type":"string"},{"name":"medium","type":"string"},{"name":"minor","type":"string"},{"name":"name","type":"string"},{"name":"params","type":"string"},{"name":"template","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/operatingsystems/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"GET","short_description":"Show an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"os_default_templates":{"doc_url":"/apidoc/v2/os_default_templates","id":"os_default_templates","api_url":"/api","name":"Os_default_templates","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/os_default_templates/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"GET","short_description":"Show a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"parameters":{"doc_url":"/apidoc/v2/parameters","id":"parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cstrong\u003enested parameters for a host, domain, subnet, host group, operating system\u003c/strong\u003e. If you are looking for \u0026lt;a href=“common_parameters.html”\u0026gt;global parameters\u0026lt;/a\u0026gt;, go to \u0026lt;a href=“common_parameters.html”\u0026gt;this link\u0026lt;/a\u0026gt;.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"GET","short_description":"List all parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"GET","short_description":"List all parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"id","type":"integer"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"permissions":{"doc_url":"/apidoc/v2/permissions","id":"permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"resource_type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/permissions/resource_types","name":"resource_types","apis":[{"api_url":"/api/permissions/resource_types","http_method":"GET","short_description":"List available resource types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"personal_access_tokens":{"doc_url":"/apidoc/v2/personal_access_tokens","id":"personal_access_tokens","api_url":"/api","name":"Personal_access_tokens","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/personal_access_tokens/index","name":"index","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"GET","short_description":"List all Personal Access Tokens for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/personal_access_tokens/show","name":"show","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"GET","short_description":"Show a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/personal_access_tokens/create","name":"create","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"POST","short_description":"Create a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"personal_access_token","full_name":"personal_access_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"personal_access_token[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expires_at","full_name":"personal_access_token[expires_at]","description":"\n\u003cp\u003eExpiry Date\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/personal_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"DELETE","short_description":"Revoke a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"plugins":{"doc_url":"/apidoc/v2/plugins","id":"plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"provisioning_templates":{"doc_url":"/apidoc/v2/provisioning_templates","id":"provisioning_templates","api_url":"/api","name":"Provisioning_templates","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default_template","values":["true","false"]},{"name":"hostgroup","type":"string"},{"name":"id","type":"integer"},{"name":"kind","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"operatingsystem","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/provisioning_templates/create","name":"create","apis":[{"api_url":"/api/provisioning_templates","http_method":"POST","short_description":"Create a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/provisioning_templates/import","name":"import","apis":[{"api_url":"/api/provisioning_templates/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"provisioning_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/provisioning_templates/build_pxe_default","name":"build_pxe_default","apis":[{"api_url":"/api/provisioning_templates/build_pxe_default","http_method":"POST","short_description":"Update the default PXE menu on all configured TFTP servers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/provisioning_templates/export","name":"export","apis":[{"api_url":"/api/provisioning_templates/:id/export","http_method":"GET","short_description":"Export a provisioning template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ptables":{"doc_url":"/apidoc/v2/ptables","id":"ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"family","type":"string"},{"name":"id","type":"integer"},{"name":"layout","type":"text"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ptables/create","name":"create","apis":[{"api_url":"/api/ptables","http_method":"POST","short_description":"Create a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ptables/import","name":"import","apis":[{"api_url":"/api/ptables/import","http_method":"POST","short_description":"Import a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"ptable[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ptables/export","name":"export","apis":[{"api_url":"/api/ptables/:id/export","http_method":"GET","short_description":"Export a partition template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"realms":{"doc_url":"/apidoc/v2/realms","id":"realms","api_url":"/api","name":"Realms","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/realms/create","name":"create","apis":[{"api_url":"/api/realms","http_method":"POST","short_description":"Create a realm","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003ename\u003c/strong\u003e field is used for the name of the realm.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"report_templates":{"doc_url":"/apidoc/v2/report_templates","id":"report_templates","api_url":"/api","name":"Report_templates","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/report_templates/index","name":"index","apis":[{"api_url":"/api/report_templates","http_method":"GET","short_description":"List all report templates","deprecated":null},{"api_url":"/api/locations/:location_id/report_templates","http_method":"GET","short_description":"List all report templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/report_templates","http_method":"GET","short_description":"List all report templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/report_templates/show","name":"show","apis":[{"api_url":"/api/report_templates/:id","http_method":"GET","short_description":"Show a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/report_templates/create","name":"create","apis":[{"api_url":"/api/report_templates","http_method":"POST","short_description":"Create a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"report_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"report_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and locations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/report_templates/import","name":"import","apis":[{"api_url":"/api/report_templates/import","http_method":"POST","short_description":"Import a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"report_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/report_templates/revision","name":"revision","apis":[{"api_url":"/api/report_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/report_templates/update","name":"update","apis":[{"api_url":"/api/report_templates/:id","http_method":"PUT","short_description":"Update a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"report_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template","full_name":"report_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and locations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/report_templates/destroy","name":"destroy","apis":[{"api_url":"/api/report_templates/:id","http_method":"DELETE","short_description":"Delete a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/report_templates/clone","name":"clone","apis":[{"api_url":"/api/report_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/report_templates/export","name":"export","apis":[{"api_url":"/api/report_templates/:id/export","http_method":"GET","short_description":"Export a report template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/report_templates/generate","name":"generate","apis":[{"api_url":"/api/report_templates/:id/generate","http_method":"POST","short_description":"Generate report from a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for this input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report uzing gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/report_templates/schedule_report","name":"schedule_report","apis":[{"api_url":"/api/report_templates/:id/schedule_report","http_method":"POST","short_description":"Schedule generating of a report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe reports are generated asynchronously. If mail_to is not given, action returns an url to get resulting report from (see \u003cstrong\u003ereport_data\u003c/strong\u003e).\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for this input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report using gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mail_to","full_name":"mail_to","description":"\n\u003cp\u003eIf set, scheduled report will be delivered via e-mail. Use \u0026#39;,\u0026#39; to separate multiple email addresses.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"generate_at","full_name":"generate_at","description":"\n\u003cp\u003eUTC time to generate report at\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"a successful response","is_array":false,"returns_object":[{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eAn ID of job, which generates report. To be used with report_data API endpoint for report data retrieval.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data_url","full_name":"data_url","description":"\n\u003cp\u003eAn url to get resulting report from. This is not available when report is delivered via e-mail.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false}],"examples":["POST /api/report_templates/:id/schedule_report/\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/report_templates/report_data","name":"report_data","apis":[{"api_url":"/api/report_templates/:id/report_data/:job_id","http_method":"GET","short_description":"Downloads a generated report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the report data as a raw response. In case the report hasn\u0026#39;t been generated yet, it will return an empty response with http status 204 - NoContent.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eID assigned to generating job by the schedule command\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"/apidoc/v2/roles","id":"roles","api_url":"/api","name":"Roles","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"builtin","values":["true","false"]},{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"permission","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/roles/clone","name":"clone","apis":[{"api_url":"/api/roles/:id/clone","http_method":"POST","short_description":"Clone a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"settings":{"doc_url":"/apidoc/v2/settings","id":"settings","api_url":"/api","name":"Settings","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"List of all settings","is_array":false,"returns_object":[{"name":"results","full_name":"results","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false}],"examples":[],"metadata":{"search":[{"name":"description","type":""},{"name":"id","type":"integer"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"Information about the setting","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAlias for setting name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eSetting unique name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"full_name","full_name":"full_name","description":"\n\u003cp\u003eSetting full user readable name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"category","full_name":"category","description":"\n\u003cp\u003eThe category of setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"category_name","full_name":"category_name","description":"\n\u003cp\u003eThe human readable name of settings category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"settings_type","full_name":"settings_type","description":"\n\u003cp\u003eValue type, that the setting accepts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescribes the purpose of the setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"default","full_name":"default","description":"\n\u003cp\u003eDefault value for the setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eSetting current value. If this setting is encypted, the value will not be returned\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"readonly","full_name":"readonly","description":"\n\u003cp\u003eIs this setting readonly?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"encrypted","full_name":"encrypted","description":"\n\u003cp\u003eIs this setting encrypted?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"config_file","full_name":"config_file","description":"\n\u003cp\u003eIf this setting needs to be changed in file, it will have the file path.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"select_values","full_name":"select_values","description":"\n\u003cp\u003eIf this setting has list of possible values, this includes the list of the values.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003eLast updated. NOTE: this will be reset to application install time, when setting is reset to default value.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Time","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[{"code":200,"description":"Information about the updated setting","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAlias for setting name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eSetting unique name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"full_name","full_name":"full_name","description":"\n\u003cp\u003eSetting full user readable name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"category","full_name":"category","description":"\n\u003cp\u003eThe category of setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"category_name","full_name":"category_name","description":"\n\u003cp\u003eThe human readable name of settings category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"settings_type","full_name":"settings_type","description":"\n\u003cp\u003eValue type, that the setting accepts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescribes the purpose of the setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"default","full_name":"default","description":"\n\u003cp\u003eDefault value for the setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eSetting current value. If this setting is encypted, the value will not be returned\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"readonly","full_name":"readonly","description":"\n\u003cp\u003eIs this setting readonly?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"encrypted","full_name":"encrypted","description":"\n\u003cp\u003eIs this setting encrypted?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"config_file","full_name":"config_file","description":"\n\u003cp\u003eIf this setting needs to be changed in file, it will have the file path.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"select_values","full_name":"select_values","description":"\n\u003cp\u003eIf this setting has list of possible values, this includes the list of the values.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003eLast updated. NOTE: this will be reset to application install time, when setting is reset to default value.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Time","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxy_hosts":{"doc_url":"/apidoc/v2/smart_proxy_hosts","id":"smart_proxy_hosts","api_url":"/api","name":"Smart_proxy_hosts","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/smart_proxy_hosts/update","name":"update","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/hosts/:host_id","http_method":"PUT","short_description":"Assign a host to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/smart_proxy_hosts/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/hosts","http_method":"GET","short_description":"Get hosts forming the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/smart_proxy_hosts/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/hosts/:host_id","http_method":"DELETE","short_description":"Unassign a given host from the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ssh_keys":{"doc_url":"/apidoc/v2/ssh_keys","id":"ssh_keys","api_url":"/api","name":"Ssh_keys","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/ssh_keys/index","name":"index","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"GET","short_description":"List all SSH keys for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ssh_keys/show","name":"show","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"GET","short_description":"Show an SSH key from a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ssh_keys/create","name":"create","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"POST","short_description":"Add an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ssh_key","full_name":"ssh_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"ssh_key[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"ssh_key[key]","description":"\n\u003cp\u003ePublic SSH key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/ssh_keys/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"DELETE","short_description":"Delete an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"table_preferences":{"doc_url":"/apidoc/v2/table_preferences","id":"table_preferences","api_url":"/api","name":"Table_preferences","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/table_preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"GET","short_description":"List of table preferences for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/table_preferences/show","name":"show","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"GET","short_description":"Table preference details of a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/table_preferences/create","name":"create","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"POST","short_description":"Creates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/table_preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"PUT","short_description":"Updates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/table_preferences/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"DELETE","short_description":"Delete a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"tasks":{"doc_url":"/apidoc/v2/tasks","id":"tasks","api_url":"/api","name":"Tasks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_combinations":{"doc_url":"/apidoc/v2/template_combinations","id":"template_combinations","api_url":"/api","name":"Template_combinations","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/template_combinations/index","name":"index","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/template_combinations/show","name":"show","apis":[{"api_url":"/api/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/template_combinations/destroy","name":"destroy","apis":[{"api_url":"/api/template_combinations/:id","http_method":"DELETE","short_description":"Delete a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_inputs":{"doc_url":"/apidoc/v2/template_inputs","id":"template_inputs","api_url":"/api","name":"Template_inputs","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/template_inputs/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"GET","short_description":"List template inputs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"input_type","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/template_inputs/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"GET","short_description":"Show template input details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/template_inputs/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"POST","short_description":"Create a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is Fact value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is Variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e, \u003ccode\u003eresource\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eAnsibleRole\u003c/code\u003e, \u003ccode\u003eAnsibleVariable\u003c/code\u003e, \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDiscoveryRule\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ArfReport\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::OvalContent\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::OvalPolicy\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::Policy\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ScapContent\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::TailoringFile\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eForemanVirtWhoConfigure::Config\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eInsightsHit\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::AlternateContentSource\u003c/code\u003e, \u003ccode\u003eKatello::ContentCredential\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eLookupValue\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplate\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e, \u003ccode\u003eWebhook\u003c/code\u003e, \u003ccode\u003eWebhookTemplate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/template_inputs/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"DELETE","short_description":"Delete a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/template_inputs/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"PUT","short_description":"Update a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is Fact value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is Variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e, \u003ccode\u003eresource\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eAnsibleRole\u003c/code\u003e, \u003ccode\u003eAnsibleVariable\u003c/code\u003e, \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDiscoveryRule\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ArfReport\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::OvalContent\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::OvalPolicy\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::Policy\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ScapContent\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::TailoringFile\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eForemanVirtWhoConfigure::Config\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eInsightsHit\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::AlternateContentSource\u003c/code\u003e, \u003ccode\u003eKatello::ContentCredential\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eLookupValue\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplate\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e, \u003ccode\u003eWebhook\u003c/code\u003e, \u003ccode\u003eWebhookTemplate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_kinds":{"doc_url":"/apidoc/v2/template_kinds","id":"template_kinds","api_url":"/api","name":"Template_kinds","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/template_kinds/index","name":"index","apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"usergroups":{"doc_url":"/apidoc/v2/usergroups","id":"usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group, can be modified by admins only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUser groups linked to external groups (LDAP) are automatically synced with these groups on update. Remember this synchronization will remove any LDAP users manually added to the Foreman user group. Only LDAP users in the external groups will remain. Internal users can be added or removed freely.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group, can be modified by admins only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"/apidoc/v2/users","id":"users","api_url":"/api","name":"Users","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/auth_source_externals/:auth_source_external_id/users","http_method":"GET","short_description":"List all users for external authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. \u0026#39;\u0026lt;field\u0026gt; DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \u0026#39;all\u0026#39; to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":{"search":[{"name":"admin","values":["true","false"]},{"name":"auth_source","type":"string"},{"name":"auth_source_type","type":"string"},{"name":"description","type":"text"},{"name":"disabled","values":["true","false"]},{"name":"firstname","type":"string"},{"name":"id","type":"integer"},{"name":"last_login_on","type":"datetime"},{"name":"lastname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"login","type":"string"},{"name":"mail","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"usergroup","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/users/show_current","name":"show_current","apis":[{"api_url":"/api/current_user","http_method":"GET","short_description":"Show the currently logged-in user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"disabled","full_name":"user[disabled]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eka\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mail_enabled","full_name":"user[mail_enabled]","description":"\n\u003cp\u003eEnable user\u0026#39;s email\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user if it is not already present. Only another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"disabled","full_name":"user[disabled]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eka\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mail_enabled","full_name":"user[mail_enabled]","description":"\n\u003cp\u003eEnable user\u0026#39;s email\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eRequired when user want to change own password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/users/extlogin","name":"extlogin","apis":[{"api_url":"/api/users/extlogin","http_method":"GET","short_description":"Use to authenticate against external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}}}} \ No newline at end of file From a98061950006a784e3699cc33d9e3da7ce9d15a6 Mon Sep 17 00:00:00 2001 From: Griffin Sullivan <48397354+Griffin-Sullivan@users.noreply.github.com> Date: Mon, 8 Jan 2024 12:24:39 -0500 Subject: [PATCH 15/19] Add webhook module --- meta/runtime.yml | 1 + plugins/modules/webhook.py | 167 + tests/fixtures/apidoc/webhook.json | 1 + tests/test_playbooks/fixtures/webhook-0.yml | 8538 +++++++++++++++++++ tests/test_playbooks/fixtures/webhook-1.yml | 229 + tests/test_playbooks/fixtures/webhook-2.yml | 170 + tests/test_playbooks/fixtures/webhook-3.yml | 112 + tests/test_playbooks/fixtures/webhook-4.yml | 233 + tests/test_playbooks/fixtures/webhook-5.yml | 229 + tests/test_playbooks/fixtures/webhook-6.yml | 230 + tests/test_playbooks/fixtures/webhook-7.yml | 170 + tests/test_playbooks/fixtures/webhook-8.yml | 170 + tests/test_playbooks/fixtures/webhook-9.yml | 112 + tests/test_playbooks/tasks/webhook.yml | 32 + tests/test_playbooks/webhook.yml | 91 + 15 files changed, 10485 insertions(+) create mode 100644 plugins/modules/webhook.py create mode 120000 tests/fixtures/apidoc/webhook.json create mode 100644 tests/test_playbooks/fixtures/webhook-0.yml create mode 100644 tests/test_playbooks/fixtures/webhook-1.yml create mode 100644 tests/test_playbooks/fixtures/webhook-2.yml create mode 100644 tests/test_playbooks/fixtures/webhook-3.yml create mode 100644 tests/test_playbooks/fixtures/webhook-4.yml create mode 100644 tests/test_playbooks/fixtures/webhook-5.yml create mode 100644 tests/test_playbooks/fixtures/webhook-6.yml create mode 100644 tests/test_playbooks/fixtures/webhook-7.yml create mode 100644 tests/test_playbooks/fixtures/webhook-8.yml create mode 100644 tests/test_playbooks/fixtures/webhook-9.yml create mode 100644 tests/test_playbooks/tasks/webhook.yml create mode 100644 tests/test_playbooks/webhook.yml diff --git a/meta/runtime.yml b/meta/runtime.yml index 068fce2f6..6c2e212db 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -82,6 +82,7 @@ action_groups: - user - usergroup - wait_for_task + - webhook plugin_routing: modules: foreman_architecture: diff --git a/plugins/modules/webhook.py b/plugins/modules/webhook.py new file mode 100644 index 000000000..0acbd12ad --- /dev/null +++ b/plugins/modules/webhook.py @@ -0,0 +1,167 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# (c) 2023, Griffin Sullivan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + + +DOCUMENTATION = ''' +--- +module: webhook +version_added: 4.0.0 +short_description: Manage Webhooks +description: + - Manage Webhooks +author: + - "Griffin Sullivan (@Griffin-Sullivan)" +options: + name: + description: + - Name of the Webhook + required: true + type: str + target_url: + description: + - The URL to call when the webhook is triggered + - Required when creating a new webhook + type: str + http_method: + description: + - The HTTP method used in the webhook + choices: + - POST + - GET + - PUT + - DELETE + - PATCH + type: str + http_content_type: + description: + - The HTTP content type for the webhook + type: str + event: + description: + - Name of the event that shall trigger the webhook + - Required when creating a new webhook + type: str + webhook_template: + description: + - Name of the webhook template + type: str + enabled: + description: + - Enable or disable the webhook + type: bool + verify_ssl: + description: + - Verify SSL certs for the webhook + type: bool + ssl_ca_certs: + description: + - X509 Certification Authorities concatenated in PEM format + type: str + webhook_username: + description: + - Username for the webhook, if required + type: str + webhook_password: + description: + - Password for the webhook, if required + type: str + http_headers: + description: + - HTTP headers for the webhook + type: str + proxy_authorization: + description: + - Authorize with client certificate and validate CA from Settings + type: bool +extends_documentation_fragment: + - theforeman.foreman.foreman + - theforeman.foreman.foreman.entity_state + - theforeman.foreman.foreman.taxonomy +''' + +EXAMPLES = ''' +- name: 'Create Webhook' + theforeman.foreman.webhook: + username: 'admin' + password: 'secret_password' + server_url: 'https://foreman.example.com' + name: 'test-webhook' + target_url: 'https://google.com' + http_method: 'GET' + event: 'actions.katello.content_view.promote_succeeded' + enabled: true + organizations: + - 'MyOrg' + locations: + - 'DC1' + +- name: 'Remove Webhook' + theforeman.foreman.webhook: + username: 'admin' + password: 'secret_password' + server_url: 'https://foreman.example.com' + name: 'test-webhook' + state: 'absent' +''' + +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + webhooks: + description: List of webhooks. + type: list + elements: dict +''' + +from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanTaxonomicEntityAnsibleModule + + +class ForemanWebhookModule(ForemanTaxonomicEntityAnsibleModule): + pass + + +def main(): + module = ForemanWebhookModule( + foreman_spec=dict( + name=dict(required=True), + target_url=dict(), + http_method=dict(choices=['POST', 'GET', 'PUT', 'DELETE', 'PATCH']), + http_content_type=dict(), + event=dict(), + webhook_template=dict(type='entity'), + verify_ssl=dict(type='bool'), + enabled=dict(type='bool'), + ssl_ca_certs=dict(), + webhook_username=dict(flat_name='user'), + webhook_password=dict(no_log=True, flat_name='password'), + http_headers=dict(), + proxy_authorization=dict(type='bool'), + ), + ) + + with module.api_connection(): + module.run() + + +if __name__ == '__main__': + main() diff --git a/tests/fixtures/apidoc/webhook.json b/tests/fixtures/apidoc/webhook.json new file mode 120000 index 000000000..6a1fea195 --- /dev/null +++ b/tests/fixtures/apidoc/webhook.json @@ -0,0 +1 @@ +luna.json \ No newline at end of file diff --git a/tests/test_playbooks/fixtures/webhook-0.yml b/tests/test_playbooks/fixtures/webhook-0.yml new file mode 100644 index 000000000..3185b110a --- /dev/null +++ b/tests/test_playbooks/fixtures/webhook-0.yml @@ -0,0 +1,8538 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"satellite_version":"6.15.0","result":"ok","status":200,"version":"3.9.0","api_version":2}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '91' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/apidoc/v2.json + response: + body: + string: "{\"docs\":{\"name\":\"Foreman\",\"info\":\"\\n\\u003cp\\u003eSatellite + API v2 is currently the default API version.\\u003c/p\\u003e\\n\",\"copyright\":\"\",\"doc_url\":\"/apidoc/v2\",\"api_url\":\"/api\",\"resources\":{\"host_subscriptions\":{\"doc_url\":\"/apidoc/v2/host_subscriptions\",\"id\":\"host_subscriptions\",\"api_url\":\"/api\",\"name\":\"Host_subscriptions\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/host_subscriptions/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/subscriptions\",\"http_method\":\"GET\",\"short_description\":\"List + a host's subscriptions\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eId + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_subscriptions/auto_attach\",\"name\":\"auto_attach\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/subscriptions/auto_attach\",\"http_method\":\"PUT\",\"short_description\":\"Trigger + an auto-attach of subscriptions\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eId + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_subscriptions/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/subscriptions\",\"http_method\":\"DELETE\",\"short_description\":\"Unregister + the host as a subscription consumer\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eId + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_subscriptions/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/hosts/subscriptions\",\"http_method\":\"POST\",\"short_description\":\"Register + a host with subscription and information\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"uuid\",\"full_name\":\"uuid\",\"description\":\"\\n\\u003cp\\u003eUUID + to use for registered host, random uuid is generated if not provided\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"facts\",\"full_name\":\"facts\",\"description\":\"\\n\\u003cp\\u003eKey-value + hash of subscription-manager facts, nesting uses a period delimiter (.)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_guest_uuids\",\"full_name\":\"hypervisor_guest_uuids\",\"description\":\"\\n\\u003cp\\u003eUUIDs + of the virtual guests from the host\\u0026#39;s hypervisor\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"installed_products\",\"full_name\":\"installed_products\",\"description\":\"\\n\\u003cp\\u003eList + of products installed on the host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"product_id\",\"full_name\":\"installed_products[product_id]\",\"description\":\"\\n\\u003cp\\u003eProduct + id as listed from a host\\u0026#39;s installed products, this is not + the same product id as the products api returns\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_name\",\"full_name\":\"installed_products[product_name]\",\"description\":\"\\n\\u003cp\\u003eProduct + name as listed from a host\\u0026#39;s installed products\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"arch\",\"full_name\":\"installed_products[arch]\",\"description\":\"\\n\\u003cp\\u003eProduct + architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"installed_products[version]\",\"description\":\"\\n\\u003cp\\u003eProduct + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"release_version\",\"full_name\":\"release_version\",\"description\":\"\\n\\u003cp\\u003eRelease + version of the content host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"service_level\",\"full_name\":\"service_level\",\"description\":\"\\n\\u003cp\\u003eA + service level for auto-healing process, e.g. SELF-SUPPORT\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lifecycle_environment_id\",\"full_name\":\"lifecycle_environment_id\",\"description\":\"\\n\\u003cp\\u003eLifecycle + Environment ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003eContent + View ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_subscriptions/remove_subscriptions\",\"name\":\"remove_subscriptions\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/subscriptions/remove_subscriptions\",\"http_method\":\"PUT\",\"short_description\":null,\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eId + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subscriptions\",\"full_name\":\"subscriptions\",\"description\":\"\\n\\u003cp\\u003eArray + of subscriptions to remove\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"id\",\"full_name\":\"subscriptions[id]\",\"description\":\"\\n\\u003cp\\u003eSubscription + Pool id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"quantity\",\"full_name\":\"subscriptions[quantity]\",\"description\":\"\\n\\u003cp\\u003eIf + specified, remove the first instance of a subscription with matching id and + quantity\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_subscriptions/add_subscriptions\",\"name\":\"add_subscriptions\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/subscriptions/add_subscriptions\",\"http_method\":\"PUT\",\"short_description\":\"Add + a subscription to a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eId + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subscriptions\",\"full_name\":\"subscriptions\",\"description\":\"\\n\\u003cp\\u003eArray + of subscriptions to add\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"id\",\"full_name\":\"subscriptions[id]\",\"description\":\"\\n\\u003cp\\u003eSubscription + Pool id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"quantity\",\"full_name\":\"subscriptions[quantity]\",\"description\":\"\\n\\u003cp\\u003eQuantity + of this subscriptions to add\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_subscriptions/product_content\",\"name\":\"product_content\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/subscriptions/product_content\",\"http_method\":\"GET\",\"short_description\":\"Get + content and overrides for the host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eId + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_access_mode_all\",\"full_name\":\"content_access_mode_all\",\"description\":\"\\n\\u003cp\\u003eGet + all content available, not just that provided by subscriptions\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_access_mode_env\",\"full_name\":\"content_access_mode_env\",\"description\":\"\\n\\u003cp\\u003eLimit + content to just that available in the host\\u0026#39;s content view version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_subscriptions/content_override\",\"name\":\"content_override\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/subscriptions/content_override\",\"http_method\":\"PUT\",\"short_description\":\"Set + content overrides for the host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eId + of the content host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"value\",\"description\":\"\\n\\u003cp\\u003eOverride + to a boolean value or \\u0026#39;default\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_overrides\",\"full_name\":\"content_overrides\",\"description\":\"\\n\\u003cp\\u003eArray + of Content override parameters\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"content_label\",\"full_name\":\"content_overrides[content_label]\",\"description\":\"\\n\\u003cp\\u003eLabel + of the content\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"content_overrides[value]\",\"description\":\"\\n\\u003cp\\u003eOverride + value. Provide a boolean value if name is \\u0026#39;enabled\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"content_overrides[name]\",\"description\":\"\\n\\u003cp\\u003eOverride + key or name. Note if name is not provided the default name will be \\u0026#39;enabled\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"remove\",\"full_name\":\"content_overrides[remove]\",\"description\":\"\\n\\u003cp\\u003eSet + true to remove an override and reset it to \\u0026#39;default\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"content_overrides_search\",\"full_name\":\"content_overrides_search\",\"description\":\"\\n\\u003cp\\u003eContent + override search parameters\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"content_overrides_search[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"content_overrides_search[page]\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"content_overrides_search[per_page]\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"content_overrides_search[order]\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"content_overrides_search[full_result]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"content_overrides_search[sort_by]\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"content_overrides_search[sort_order]\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"content_overrides_search[enabled]\",\"description\":\"\\n\\u003cp\\u003eSet + true to override to enabled; Set false to override to disabled.\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"remove\",\"full_name\":\"content_overrides_search[remove]\",\"description\":\"\\n\\u003cp\\u003eSet + true to remove an override and reset it to \\u0026#39;default\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_subscriptions/available_release_versions\",\"name\":\"available_release_versions\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/subscriptions/available_release_versions\",\"http_method\":\"GET\",\"short_description\":\"Show + releases available for the content host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eid + of host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_subscriptions/enabled_repositories\",\"name\":\"enabled_repositories\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/subscriptions/enabled_repositories\",\"http_method\":\"GET\",\"short_description\":\"Show + repositories enabled on the host that are known to Katello\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eid + of host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"interfaces\":{\"doc_url\":\"/apidoc/v2/interfaces\",\"id\":\"interfaces\",\"api_url\":\"/api\",\"name\":\"Interfaces\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/interfaces/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/interfaces\",\"http_method\":\"GET\",\"short_description\":\"List + all interfaces for host\",\"deprecated\":null},{\"api_url\":\"/api/domains/:domain_id/interfaces\",\"http_method\":\"GET\",\"short_description\":\"List + all interfaces for domain\",\"deprecated\":null},{\"api_url\":\"/api/subnets/:subnet_id/interfaces\",\"http_method\":\"GET\",\"short_description\":\"List + all interfaces for subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"domain_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"subnet_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/interfaces/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/interfaces/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an interface for host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + or name of interface\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/interfaces/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/interfaces\",\"http_method\":\"POST\",\"short_description\":\"Create + an interface on a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interface\",\"full_name\":\"interface\",\"description\":\"\\n\\u003cp\\u003einterface + information\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"mac\",\"full_name\":\"interface[mac]\",\"description\":\"\\n\\u003cp\\u003eMAC + address of interface. Required for managed interfaces on bare metal.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip\",\"full_name\":\"interface[ip]\",\"description\":\"\\n\\u003cp\\u003eIPv4 + address of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip6\",\"full_name\":\"interface[ip6]\",\"description\":\"\\n\\u003cp\\u003eIPv6 + address of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"interface[type]\",\"description\":\"\\n\\u003cp\\u003eInterface + type, e.g. bmc. Default is interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003einterface\\u003c/code\\u003e, \\u003ccode\\u003ebmc\\u003c/code\\u003e, + \\u003ccode\\u003ebond\\u003c/code\\u003e, \\u003ccode\\u003ebridge\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"interface[name]\",\"description\":\"\\n\\u003cp\\u003eInterface\\u0026#39;s + DNS name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"interface[subnet_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + subnet ID of IPv4 interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet6_id\",\"full_name\":\"interface[subnet6_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + subnet ID of IPv6 interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"interface[domain_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + domain ID of interface. Required for primary interfaces on managed hosts.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"identifier\",\"full_name\":\"interface[identifier]\",\"description\":\"\\n\\u003cp\\u003eDevice + identifier, e.g. eth0 or eth1.1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"managed\",\"full_name\":\"interface[managed]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be managed via DHCP and DNS capsule and should it be configured + during provisioning?\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"primary\",\"full_name\":\"interface[primary]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for constructing the FQDN of the host? Each managed + hosts needs to have one primary interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provision\",\"full_name\":\"interface[provision]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? + Each managed hosts needs to have one provision interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"username\",\"full_name\":\"interface[username]\",\"description\":\"\\n\\u003cp\\u003eOnly + for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"interface[password]\",\"description\":\"\\n\\u003cp\\u003eOnly + for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provider\",\"full_name\":\"interface[provider]\",\"description\":\"\\n\\u003cp\\u003eInterface + provider, e.g. IPMI. Only for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eIPMI\\u003c/code\\u003e, \\u003ccode\\u003eRedfish\\u003c/code\\u003e, + \\u003ccode\\u003eSSH\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"virtual\",\"full_name\":\"interface[virtual]\",\"description\":\"\\n\\u003cp\\u003eAlias + or VLAN device\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tag\",\"full_name\":\"interface[tag]\",\"description\":\"\\n\\u003cp\\u003eVLAN + tag, this attribute has precedence over the subnet VLAN ID. Only for virtual + interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mtu\",\"full_name\":\"interface[mtu]\",\"description\":\"\\n\\u003cp\\u003eMTU, + this attribute has precedence over the subnet MTU.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attached_to\",\"full_name\":\"interface[attached_to]\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the interface to which this interface belongs, e.g. eth1. Only for virtual + interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mode\",\"full_name\":\"interface[mode]\",\"description\":\"\\n\\u003cp\\u003eBond + mode of the interface, e.g. balance-rr. Only for bond interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ebalance-rr\\u003c/code\\u003e, \\u003ccode\\u003eactive-backup\\u003c/code\\u003e, + \\u003ccode\\u003ebalance-xor\\u003c/code\\u003e, \\u003ccode\\u003ebroadcast\\u003c/code\\u003e, + \\u003ccode\\u003e802.3ad\\u003c/code\\u003e, \\u003ccode\\u003ebalance-tlb\\u003c/code\\u003e, + \\u003ccode\\u003ebalance-alb\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attached_devices\",\"full_name\":\"interface[attached_devices]\",\"description\":\"\\n\\u003cp\\u003eIdentifiers + of attached interfaces, e.g. `[\\u0026#39;eth1\\u0026#39;, \\u0026#39;eth2\\u0026#39;]`. + For bond interfaces those are the slaves. Only for bond and bridges interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"bond_options\",\"full_name\":\"interface[bond_options]\",\"description\":\"\\n\\u003cp\\u003eSpace + separated options, e.g. miimon=100. Only for bond interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_attributes\",\"full_name\":\"interface[compute_attributes]\",\"description\":\"\\n\\u003cp\\u003eAdditional + compute resource specific attributes for the interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"execution\",\"full_name\":\"interface[execution]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for remote execution?\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/interfaces/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/interfaces/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a host's interface\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of interface\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interface\",\"full_name\":\"interface\",\"description\":\"\\n\\u003cp\\u003einterface + information\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"mac\",\"full_name\":\"interface[mac]\",\"description\":\"\\n\\u003cp\\u003eMAC + address of interface. Required for managed interfaces on bare metal.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip\",\"full_name\":\"interface[ip]\",\"description\":\"\\n\\u003cp\\u003eIPv4 + address of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip6\",\"full_name\":\"interface[ip6]\",\"description\":\"\\n\\u003cp\\u003eIPv6 + address of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"interface[type]\",\"description\":\"\\n\\u003cp\\u003eInterface + type, e.g. bmc. Default is interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003einterface\\u003c/code\\u003e, \\u003ccode\\u003ebmc\\u003c/code\\u003e, + \\u003ccode\\u003ebond\\u003c/code\\u003e, \\u003ccode\\u003ebridge\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"interface[name]\",\"description\":\"\\n\\u003cp\\u003eInterface\\u0026#39;s + DNS name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"interface[subnet_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + subnet ID of IPv4 interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet6_id\",\"full_name\":\"interface[subnet6_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + subnet ID of IPv6 interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"interface[domain_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + domain ID of interface. Required for primary interfaces on managed hosts.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"identifier\",\"full_name\":\"interface[identifier]\",\"description\":\"\\n\\u003cp\\u003eDevice + identifier, e.g. eth0 or eth1.1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"managed\",\"full_name\":\"interface[managed]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be managed via DHCP and DNS capsule and should it be configured + during provisioning?\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"primary\",\"full_name\":\"interface[primary]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for constructing the FQDN of the host? Each managed + hosts needs to have one primary interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provision\",\"full_name\":\"interface[provision]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? + Each managed hosts needs to have one provision interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"username\",\"full_name\":\"interface[username]\",\"description\":\"\\n\\u003cp\\u003eOnly + for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"interface[password]\",\"description\":\"\\n\\u003cp\\u003eOnly + for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provider\",\"full_name\":\"interface[provider]\",\"description\":\"\\n\\u003cp\\u003eInterface + provider, e.g. IPMI. Only for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eIPMI\\u003c/code\\u003e, \\u003ccode\\u003eRedfish\\u003c/code\\u003e, + \\u003ccode\\u003eSSH\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"virtual\",\"full_name\":\"interface[virtual]\",\"description\":\"\\n\\u003cp\\u003eAlias + or VLAN device\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tag\",\"full_name\":\"interface[tag]\",\"description\":\"\\n\\u003cp\\u003eVLAN + tag, this attribute has precedence over the subnet VLAN ID. Only for virtual + interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mtu\",\"full_name\":\"interface[mtu]\",\"description\":\"\\n\\u003cp\\u003eMTU, + this attribute has precedence over the subnet MTU.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attached_to\",\"full_name\":\"interface[attached_to]\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the interface to which this interface belongs, e.g. eth1. Only for virtual + interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mode\",\"full_name\":\"interface[mode]\",\"description\":\"\\n\\u003cp\\u003eBond + mode of the interface, e.g. balance-rr. Only for bond interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ebalance-rr\\u003c/code\\u003e, \\u003ccode\\u003eactive-backup\\u003c/code\\u003e, + \\u003ccode\\u003ebalance-xor\\u003c/code\\u003e, \\u003ccode\\u003ebroadcast\\u003c/code\\u003e, + \\u003ccode\\u003e802.3ad\\u003c/code\\u003e, \\u003ccode\\u003ebalance-tlb\\u003c/code\\u003e, + \\u003ccode\\u003ebalance-alb\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attached_devices\",\"full_name\":\"interface[attached_devices]\",\"description\":\"\\n\\u003cp\\u003eIdentifiers + of attached interfaces, e.g. `[\\u0026#39;eth1\\u0026#39;, \\u0026#39;eth2\\u0026#39;]`. + For bond interfaces those are the slaves. Only for bond and bridges interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"bond_options\",\"full_name\":\"interface[bond_options]\",\"description\":\"\\n\\u003cp\\u003eSpace + separated options, e.g. miimon=100. Only for bond interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_attributes\",\"full_name\":\"interface[compute_attributes]\",\"description\":\"\\n\\u003cp\\u003eAdditional + compute resource specific attributes for the interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"execution\",\"full_name\":\"interface[execution]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for remote execution?\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/interfaces/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/interfaces/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a host's interface\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of interface\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"subnets\":{\"doc_url\":\"/apidoc/v2/subnets\",\"id\":\"subnets\",\"api_url\":\"/api\",\"name\":\"Subnets\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/subnets/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/subnets\",\"http_method\":\"GET\",\"short_description\":\"List + of subnets\",\"deprecated\":null},{\"api_url\":\"/api/domains/:domain_id/subnets\",\"http_method\":\"GET\",\"short_description\":\"List + of subnets for a domain\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/subnets\",\"http_method\":\"GET\",\"short_description\":\"List + of subnets per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/subnets\",\"http_method\":\"GET\",\"short_description\":\"List + of subnets per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"domain_id\",\"full_name\":\"domain_id\",\"description\":\"\\n\\u003cp\\u003eID + of domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"boot_mode\",\"type\":\"string\"},{\"name\":\"dns_primary\",\"type\":\"string\"},{\"name\":\"dns_secondary\",\"type\":\"string\"},{\"name\":\"domain\",\"type\":\"string\"},{\"name\":\"gateway\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"ipam\",\"type\":\"string\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"mask\",\"type\":\"string\"},{\"name\":\"mtu\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"text\"},{\"name\":\"network\",\"type\":\"string\"},{\"name\":\"nic_delay\",\"type\":\"integer\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"params\",\"type\":\"string\"},{\"name\":\"type\",\"type\":\"string\"},{\"name\":\"vlanid\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/subnets/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/subnets/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"show_hidden_parameters\",\"full_name\":\"show_hidden_parameters\",\"description\":\"\\n\\u003cp\\u003eDisplay + hidden parameter values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/subnets/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/subnets\",\"http_method\":\"POST\",\"short_description\":\"Create + a subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet\",\"full_name\":\"subnet\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"subnet[name]\",\"description\":\"\\n\\u003cp\\u003eSubnet + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"subnet[description]\",\"description\":\"\\n\\u003cp\\u003eSubnet + description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"network_type\",\"full_name\":\"subnet[network_type]\",\"description\":\"\\n\\u003cp\\u003eType + or protocol, IPv4 or IPv6, defaults to IPv4\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eIPv4\\u003c/code\\u003e, \\u003ccode\\u003eIPv6\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"network\",\"full_name\":\"subnet[network]\",\"description\":\"\\n\\u003cp\\u003eSubnet + network\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cidr\",\"full_name\":\"subnet[cidr]\",\"description\":\"\\n\\u003cp\\u003eNetwork + prefix in CIDR notation\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mask\",\"full_name\":\"subnet[mask]\",\"description\":\"\\n\\u003cp\\u003eNetmask + for this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"gateway\",\"full_name\":\"subnet[gateway]\",\"description\":\"\\n\\u003cp\\u003eSubnet + gateway\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dns_primary\",\"full_name\":\"subnet[dns_primary]\",\"description\":\"\\n\\u003cp\\u003ePrimary + DNS for this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dns_secondary\",\"full_name\":\"subnet[dns_secondary]\",\"description\":\"\\n\\u003cp\\u003eSecondary + DNS for this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ipam\",\"full_name\":\"subnet[ipam]\",\"description\":\"\\n\\u003cp\\u003eIP + Address auto suggestion mode for this subnet.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eDHCP\\u003c/code\\u003e, \\u003ccode\\u003eInternal + DB\\u003c/code\\u003e, \\u003ccode\\u003eRandom DB\\u003c/code\\u003e, \\u003ccode\\u003eEUI-64\\u003c/code\\u003e, + \\u003ccode\\u003eExternal IPAM\\u003c/code\\u003e, \\u003ccode\\u003eNone\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"externalipam_group\",\"full_name\":\"subnet[externalipam_group]\",\"description\":\"\\n\\u003cp\\u003eExternal + IPAM group - only relevant when IPAM is set to external\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"from\",\"full_name\":\"subnet[from]\",\"description\":\"\\n\\u003cp\\u003eStarting + IP Address for IP auto suggestion\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"to\",\"full_name\":\"subnet[to]\",\"description\":\"\\n\\u003cp\\u003eEnding + IP Address for IP auto suggestion\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"vlanid\",\"full_name\":\"subnet[vlanid]\",\"description\":\"\\n\\u003cp\\u003eVLAN + ID for this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mtu\",\"full_name\":\"subnet[mtu]\",\"description\":\"\\n\\u003cp\\u003eMTU + for this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_ids\",\"full_name\":\"subnet[domain_ids]\",\"description\":\"\\n\\u003cp\\u003eDomains + in which this subnet is part\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dhcp_id\",\"full_name\":\"subnet[dhcp_id]\",\"description\":\"\\n\\u003cp\\u003eDHCP + Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tftp_id\",\"full_name\":\"subnet[tftp_id]\",\"description\":\"\\n\\u003cp\\u003eTFTP + Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"httpboot_id\",\"full_name\":\"subnet[httpboot_id]\",\"description\":\"\\n\\u003cp\\u003eHTTPBoot + Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"externalipam_id\",\"full_name\":\"subnet[externalipam_id]\",\"description\":\"\\n\\u003cp\\u003eExternal + IPAM Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dns_id\",\"full_name\":\"subnet[dns_id]\",\"description\":\"\\n\\u003cp\\u003eDNS + Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"subnet[template_id]\",\"description\":\"\\n\\u003cp\\u003eTemplate + HTTP(S) Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"bmc_id\",\"full_name\":\"subnet[bmc_id]\",\"description\":\"\\n\\u003cp\\u003eBMC + Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"discovery_id\",\"full_name\":\"subnet[discovery_id]\",\"description\":\"\\n\\u003cp\\u003eID + of Discovery Capsule to use within this subnet for managing connection to + discovered hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"boot_mode\",\"full_name\":\"subnet[boot_mode]\",\"description\":\"\\n\\u003cp\\u003eDefault + boot mode for interfaces assigned to this subnet.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eStatic\\u003c/code\\u003e, \\u003ccode\\u003eDHCP\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_parameters_attributes\",\"full_name\":\"subnet[subnet_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eArray + of parameters (name, value)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"subnet[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"subnet[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"remote_execution_proxy_ids\",\"full_name\":\"subnet[remote_execution_proxy_ids]\",\"description\":\"\\n\\u003cp\\u003eList + of Capsule IDs to be used for remote execution\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/subnets/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/subnets/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eSubnet + numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet\",\"full_name\":\"subnet\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"subnet[name]\",\"description\":\"\\n\\u003cp\\u003eSubnet + name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"subnet[description]\",\"description\":\"\\n\\u003cp\\u003eSubnet + description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"network_type\",\"full_name\":\"subnet[network_type]\",\"description\":\"\\n\\u003cp\\u003eType + or protocol, IPv4 or IPv6, defaults to IPv4\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eIPv4\\u003c/code\\u003e, \\u003ccode\\u003eIPv6\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"network\",\"full_name\":\"subnet[network]\",\"description\":\"\\n\\u003cp\\u003eSubnet + network\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cidr\",\"full_name\":\"subnet[cidr]\",\"description\":\"\\n\\u003cp\\u003eNetwork + prefix in CIDR notation\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mask\",\"full_name\":\"subnet[mask]\",\"description\":\"\\n\\u003cp\\u003eNetmask + for this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"gateway\",\"full_name\":\"subnet[gateway]\",\"description\":\"\\n\\u003cp\\u003eSubnet + gateway\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dns_primary\",\"full_name\":\"subnet[dns_primary]\",\"description\":\"\\n\\u003cp\\u003ePrimary + DNS for this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dns_secondary\",\"full_name\":\"subnet[dns_secondary]\",\"description\":\"\\n\\u003cp\\u003eSecondary + DNS for this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ipam\",\"full_name\":\"subnet[ipam]\",\"description\":\"\\n\\u003cp\\u003eIP + Address auto suggestion mode for this subnet.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eDHCP\\u003c/code\\u003e, \\u003ccode\\u003eInternal + DB\\u003c/code\\u003e, \\u003ccode\\u003eRandom DB\\u003c/code\\u003e, \\u003ccode\\u003eEUI-64\\u003c/code\\u003e, + \\u003ccode\\u003eExternal IPAM\\u003c/code\\u003e, \\u003ccode\\u003eNone\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"externalipam_group\",\"full_name\":\"subnet[externalipam_group]\",\"description\":\"\\n\\u003cp\\u003eExternal + IPAM group - only relevant when IPAM is set to external\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"from\",\"full_name\":\"subnet[from]\",\"description\":\"\\n\\u003cp\\u003eStarting + IP Address for IP auto suggestion\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"to\",\"full_name\":\"subnet[to]\",\"description\":\"\\n\\u003cp\\u003eEnding + IP Address for IP auto suggestion\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"vlanid\",\"full_name\":\"subnet[vlanid]\",\"description\":\"\\n\\u003cp\\u003eVLAN + ID for this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mtu\",\"full_name\":\"subnet[mtu]\",\"description\":\"\\n\\u003cp\\u003eMTU + for this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_ids\",\"full_name\":\"subnet[domain_ids]\",\"description\":\"\\n\\u003cp\\u003eDomains + in which this subnet is part\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dhcp_id\",\"full_name\":\"subnet[dhcp_id]\",\"description\":\"\\n\\u003cp\\u003eDHCP + Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tftp_id\",\"full_name\":\"subnet[tftp_id]\",\"description\":\"\\n\\u003cp\\u003eTFTP + Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"httpboot_id\",\"full_name\":\"subnet[httpboot_id]\",\"description\":\"\\n\\u003cp\\u003eHTTPBoot + Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"externalipam_id\",\"full_name\":\"subnet[externalipam_id]\",\"description\":\"\\n\\u003cp\\u003eExternal + IPAM Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dns_id\",\"full_name\":\"subnet[dns_id]\",\"description\":\"\\n\\u003cp\\u003eDNS + Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"subnet[template_id]\",\"description\":\"\\n\\u003cp\\u003eTemplate + HTTP(S) Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"bmc_id\",\"full_name\":\"subnet[bmc_id]\",\"description\":\"\\n\\u003cp\\u003eBMC + Capsule ID to use within this subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"discovery_id\",\"full_name\":\"subnet[discovery_id]\",\"description\":\"\\n\\u003cp\\u003eID + of Discovery Capsule to use within this subnet for managing connection to + discovered hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"boot_mode\",\"full_name\":\"subnet[boot_mode]\",\"description\":\"\\n\\u003cp\\u003eDefault + boot mode for interfaces assigned to this subnet.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eStatic\\u003c/code\\u003e, \\u003ccode\\u003eDHCP\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_parameters_attributes\",\"full_name\":\"subnet[subnet_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eArray + of parameters (name, value)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"subnet[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"subnet[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"remote_execution_proxy_ids\",\"full_name\":\"subnet[remote_execution_proxy_ids]\",\"description\":\"\\n\\u003cp\\u003eList + of Capsule IDs to be used for remote execution\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/subnets/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/subnets/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eSubnet + numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/subnets/freeip\",\"name\":\"freeip\",\"apis\":[{\"api_url\":\"/api/subnets/:id/freeip\",\"http_method\":\"GET\",\"short_description\":\"Provides + an unused IP address in this subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mac\",\"full_name\":\"mac\",\"description\":\"\\n\\u003cp\\u003eMAC + address to reuse the IP for this host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"excluded_ips\",\"full_name\":\"excluded_ips\",\"description\":\"\\n\\u003cp\\u003eIP + addresses that should be excluded from suggestion\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"registration\":{\"doc_url\":\"/apidoc/v2/registration\",\"id\":\"registration\",\"api_url\":\"/api\",\"name\":\"Registration\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/registration/global\",\"name\":\"global\",\"apis\":[{\"api_url\":\"/api/register\",\"http_method\":\"GET\",\"short_description\":\"Render + Global registration template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the Organization to register the host in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eID + of the Location to register the host in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of the Host group to register the host in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of the Operating System to register the host in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"setup_insights\",\"full_name\":\"setup_insights\",\"description\":\"\\n\\u003cp\\u003eSet + \\u0026#39;host_registration_insights\\u0026#39; parameter for the host. If + it is set to true, insights client will be installed and registered on Red + Hat family operating systems\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"setup_remote_execution\",\"full_name\":\"setup_remote_execution\",\"description\":\"\\n\\u003cp\\u003eSet + \\u0026#39;host_registration_remote_execution\\u0026#39; parameter for the + host. If it is set to true, SSH keys will be installed on the host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"packages\",\"full_name\":\"packages\",\"description\":\"\\n\\u003cp\\u003ePackages + to install on the host when registered. Can be set by `host_packages` parameter, + example: `pkg1 pkg2`\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"update_packages\",\"full_name\":\"update_packages\",\"description\":\"\\n\\u003cp\\u003eUpdate + all packages on the host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repo\",\"full_name\":\"repo\",\"description\":\"\\n\\u003cp\\u003eRepository + URL / details, for example for Debian OS family: \\u0026#39;deb \\u003ca href=\\\"http://deb.example.com\\\"\\u003edeb.example.com\\u003c/a\\u003e/ + buster 1.0\\u0026#39;, for Red Hat OS family: \\u0026#39;\\u003ca href=\\\"http://yum.theforeman.org/client/latest/el8/x86_64\\\"\\u003eyum.theforeman.org/client/latest/el8/x86_64\\u003c/a\\u003e/\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repo_gpg_key_url\",\"full_name\":\"repo_gpg_key_url\",\"description\":\"\\n\\u003cp\\u003eURL + of the GPG key for the repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"remote_execution_interface\",\"full_name\":\"remote_execution_interface\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the Host interface for Remote execution\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"setup_remote_execution_pull\",\"full_name\":\"setup_remote_execution_pull\",\"description\":\"\\n\\u003cp\\u003eSet + \\u0026#39;host_registration_remote_execution_pull\\u0026#39; parameter for + the host. If it is set to true, pull provider client will be deployed on the + host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/registration/host\",\"name\":\"host\",\"apis\":[{\"api_url\":\"/api/register\",\"http_method\":\"POST\",\"short_description\":\"Find + or create a host and render the 'Host initial configuration' template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host\",\"full_name\":\"host\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"host[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"host[location_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"host[organization_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip\",\"full_name\":\"host[ip]\",\"description\":\"\\n\\u003cp\\u003eIPv4 + address, not required if using a subnet with DHCP Capsule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip6\",\"full_name\":\"host[ip6]\",\"description\":\"\\n\\u003cp\\u003eIPv6 + address, not required if using a subnet with DHCP Capsule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mac\",\"full_name\":\"host[mac]\",\"description\":\"\\n\\u003cp\\u003erequired + for managed host that is bare metal, not required if it\\u0026#39;s a virtual + machine\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"host[domain_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"host[operatingsystem_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"host[subnet_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"model_id\",\"full_name\":\"host[model_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"host[hostgroup_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_parameters_attributes\",\"full_name\":\"host[host_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eHost\\u0026#39;s + parameters (array or indexed hash)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"host[host_parameters_attributes][name]\",\"description\":\"\\n\\u003cp\\u003eName + of the parameter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"host[host_parameters_attributes][value]\",\"description\":\"\\n\\u003cp\\u003eParameter + value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter_type\",\"full_name\":\"host[host_parameters_attributes][parameter_type]\",\"description\":\"\\n\\u003cp\\u003eType + of value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"host[host_parameters_attributes][hidden_value]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"build\",\"full_name\":\"host[build]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"host[enabled]\",\"description\":\"\\n\\u003cp\\u003eInclude + this host within Satellite reporting\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"managed\",\"full_name\":\"host[managed]\",\"description\":\"\\n\\u003cp\\u003eTrue/False + flag whether a host is managed or unmanaged. Note: this value also determines + whether several parameters are required or not\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"comment\",\"full_name\":\"host[comment]\",\"description\":\"\\n\\u003cp\\u003eAdditional + information about this host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interfaces_attributes\",\"full_name\":\"host[interfaces_attributes]\",\"description\":\"\\n\\u003cp\\u003eHost\\u0026#39;s + network interfaces\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"mac\",\"full_name\":\"host[interfaces_attributes][mac]\",\"description\":\"\\n\\u003cp\\u003eMAC + address of interface. Required for managed interfaces on bare metal.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip\",\"full_name\":\"host[interfaces_attributes][ip]\",\"description\":\"\\n\\u003cp\\u003eIPv4 + address of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip6\",\"full_name\":\"host[interfaces_attributes][ip6]\",\"description\":\"\\n\\u003cp\\u003eIPv6 + address of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"host[interfaces_attributes][type]\",\"description\":\"\\n\\u003cp\\u003eInterface + type, e.g. bmc. Default is interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003einterface\\u003c/code\\u003e, \\u003ccode\\u003ebmc\\u003c/code\\u003e, + \\u003ccode\\u003ebond\\u003c/code\\u003e, \\u003ccode\\u003ebridge\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"host[interfaces_attributes][name]\",\"description\":\"\\n\\u003cp\\u003eInterface\\u0026#39;s + DNS name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"host[interfaces_attributes][subnet_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + subnet ID of IPv4 interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet6_id\",\"full_name\":\"host[interfaces_attributes][subnet6_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + subnet ID of IPv6 interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"host[interfaces_attributes][domain_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + domain ID of interface. Required for primary interfaces on managed hosts.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"identifier\",\"full_name\":\"host[interfaces_attributes][identifier]\",\"description\":\"\\n\\u003cp\\u003eDevice + identifier, e.g. eth0 or eth1.1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"managed\",\"full_name\":\"host[interfaces_attributes][managed]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be managed via DHCP and DNS capsule and should it be configured + during provisioning?\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"primary\",\"full_name\":\"host[interfaces_attributes][primary]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for constructing the FQDN of the host? Each managed + hosts needs to have one primary interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provision\",\"full_name\":\"host[interfaces_attributes][provision]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? + Each managed hosts needs to have one provision interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"username\",\"full_name\":\"host[interfaces_attributes][username]\",\"description\":\"\\n\\u003cp\\u003eOnly + for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"host[interfaces_attributes][password]\",\"description\":\"\\n\\u003cp\\u003eOnly + for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provider\",\"full_name\":\"host[interfaces_attributes][provider]\",\"description\":\"\\n\\u003cp\\u003eInterface + provider, e.g. IPMI. Only for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eIPMI\\u003c/code\\u003e, \\u003ccode\\u003eRedfish\\u003c/code\\u003e, + \\u003ccode\\u003eSSH\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"virtual\",\"full_name\":\"host[interfaces_attributes][virtual]\",\"description\":\"\\n\\u003cp\\u003eAlias + or VLAN device\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tag\",\"full_name\":\"host[interfaces_attributes][tag]\",\"description\":\"\\n\\u003cp\\u003eVLAN + tag, this attribute has precedence over the subnet VLAN ID. Only for virtual + interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mtu\",\"full_name\":\"host[interfaces_attributes][mtu]\",\"description\":\"\\n\\u003cp\\u003eMTU, + this attribute has precedence over the subnet MTU.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attached_to\",\"full_name\":\"host[interfaces_attributes][attached_to]\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the interface to which this interface belongs, e.g. eth1. Only for virtual + interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mode\",\"full_name\":\"host[interfaces_attributes][mode]\",\"description\":\"\\n\\u003cp\\u003eBond + mode of the interface, e.g. balance-rr. Only for bond interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ebalance-rr\\u003c/code\\u003e, \\u003ccode\\u003eactive-backup\\u003c/code\\u003e, + \\u003ccode\\u003ebalance-xor\\u003c/code\\u003e, \\u003ccode\\u003ebroadcast\\u003c/code\\u003e, + \\u003ccode\\u003e802.3ad\\u003c/code\\u003e, \\u003ccode\\u003ebalance-tlb\\u003c/code\\u003e, + \\u003ccode\\u003ebalance-alb\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attached_devices\",\"full_name\":\"host[interfaces_attributes][attached_devices]\",\"description\":\"\\n\\u003cp\\u003eIdentifiers + of attached interfaces, e.g. `[\\u0026#39;eth1\\u0026#39;, \\u0026#39;eth2\\u0026#39;]`. + For bond interfaces those are the slaves. Only for bond and bridges interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"bond_options\",\"full_name\":\"host[interfaces_attributes][bond_options]\",\"description\":\"\\n\\u003cp\\u003eSpace + separated options, e.g. miimon=100. Only for bond interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_attributes\",\"full_name\":\"host[interfaces_attributes][compute_attributes]\",\"description\":\"\\n\\u003cp\\u003eAdditional + compute resource specific attributes for the interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"content_facet_attributes\",\"full_name\":\"host[content_facet_attributes]\",\"description\":\"\\n\\u003cp\\u003eParameters + for host\\u0026#39;s content_facet facet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"content_view_id\",\"full_name\":\"host[content_facet_attributes][content_view_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lifecycle_environment_id\",\"full_name\":\"host[content_facet_attributes][lifecycle_environment_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_source_id\",\"full_name\":\"host[content_facet_attributes][content_source_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"kickstart_repository_id\",\"full_name\":\"host[content_facet_attributes][kickstart_repository_id]\",\"description\":\"\\n\\u003cp\\u003eRepository + Id associated with the kickstart repo used for provisioning\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"subscription_facet_attributes\",\"full_name\":\"host[subscription_facet_attributes]\",\"description\":\"\\n\\u003cp\\u003eParameters + for host\\u0026#39;s subscription_facet facet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"release_version\",\"full_name\":\"host[subscription_facet_attributes][release_version]\",\"description\":\"\\n\\u003cp\\u003eRelease + version for this Host to use (7Server, 7.1, etc)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"autoheal\",\"full_name\":\"host[subscription_facet_attributes][autoheal]\",\"description\":\"\\n\\u003cp\\u003eSets + whether the Host will autoheal subscriptions upon checkin\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_usage\",\"full_name\":\"host[subscription_facet_attributes][purpose_usage]\",\"description\":\"\\n\\u003cp\\u003eSets + the system purpose usage\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_role\",\"full_name\":\"host[subscription_facet_attributes][purpose_role]\",\"description\":\"\\n\\u003cp\\u003eSets + the system purpose usage\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_addons\",\"full_name\":\"host[subscription_facet_attributes][purpose_addons]\",\"description\":\"\\n\\u003cp\\u003eSets + the system add-ons\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"service_level\",\"full_name\":\"host[subscription_facet_attributes][service_level]\",\"description\":\"\\n\\u003cp\\u003eService + level to be used for autoheal\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_guest_uuids\",\"full_name\":\"host[subscription_facet_attributes][hypervisor_guest_uuids]\",\"description\":\"\\n\\u003cp\\u003eList + of hypervisor guest uuids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"installed_products_attributes\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes]\",\"description\":\"\\n\\u003cp\\u003eList + of products installed on the host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"product_id\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][product_id]\",\"description\":\"\\n\\u003cp\\u003eProduct + id as listed from a host\\u0026#39;s installed products, this is not + the same product id as the products api returns\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_name\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][product_name]\",\"description\":\"\\n\\u003cp\\u003eProduct + name as listed from a host\\u0026#39;s installed products\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"arch\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][arch]\",\"description\":\"\\n\\u003cp\\u003eProduct + architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][version]\",\"description\":\"\\n\\u003cp\\u003eProduct + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}]}]},{\"name\":\"setup_insights\",\"full_name\":\"setup_insights\",\"description\":\"\\n\\u003cp\\u003eSet + \\u0026#39;host_registration_insights\\u0026#39; parameter for the host. If + it is set to true, insights client will be installed and registered on Red + Hat family operating systems\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"setup_remote_execution\",\"full_name\":\"setup_remote_execution\",\"description\":\"\\n\\u003cp\\u003eSet + \\u0026#39;host_registration_remote_execution\\u0026#39; parameter for the + host. If it is set to true, SSH keys will be installed on the host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"remote_execution_interface\",\"full_name\":\"remote_execution_interface\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the Host interface for Remote execution\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"setup_remote_execution_pull\",\"full_name\":\"setup_remote_execution_pull\",\"description\":\"\\n\\u003cp\\u003eSet + \\u0026#39;host_registration_remote_execution_pull\\u0026#39; parameter for + the host. If it is set to true, pull provider client will be deployed on the + host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"registration_commands\":{\"doc_url\":\"/apidoc/v2/registration_commands\",\"id\":\"registration_commands\",\"api_url\":\"/api\",\"name\":\"Registration_commands\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/registration_commands/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/registration_commands\",\"http_method\":\"POST\",\"short_description\":\"Generate + global registration command\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"registration_command\",\"full_name\":\"registration_command\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"organization_id\",\"full_name\":\"registration_command[organization_id]\",\"description\":\"\\n\\u003cp\\u003eID + of the Organization to register the host in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"registration_command[location_id]\",\"description\":\"\\n\\u003cp\\u003eID + of the Location to register the host in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"registration_command[hostgroup_id]\",\"description\":\"\\n\\u003cp\\u003eID + of the Host group to register the host in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"registration_command[operatingsystem_id]\",\"description\":\"\\n\\u003cp\\u003eID + of the Operating System to register the host in. Operating system must have + a `host_init_config` template assigned\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy_id\",\"full_name\":\"registration_command[smart_proxy_id]\",\"description\":\"\\n\\u003cp\\u003eID + of the Capsule. This Capsule must have enabled both the \\u0026#39;Templates\\u0026#39; + and \\u0026#39;Registration\\u0026#39; features\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"setup_insights\",\"full_name\":\"registration_command[setup_insights]\",\"description\":\"\\n\\u003cp\\u003eSet + \\u0026#39;host_registration_insights\\u0026#39; parameter for the host. If + it is set to true, insights client will be installed and registered on Red + Hat family operating systems\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"setup_remote_execution\",\"full_name\":\"registration_command[setup_remote_execution]\",\"description\":\"\\n\\u003cp\\u003eSet + \\u0026#39;host_registration_remote_execution\\u0026#39; parameter for the + host. If it is set to true, SSH keys will be installed on the host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"jwt_expiration\",\"full_name\":\"registration_command[jwt_expiration]\",\"description\":\"\\n\\u003cp\\u003eExpiration + of the authorization token (in hours)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"insecure\",\"full_name\":\"registration_command[insecure]\",\"description\":\"\\n\\u003cp\\u003eEnable + insecure argument for the initial curl\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"packages\",\"full_name\":\"registration_command[packages]\",\"description\":\"\\n\\u003cp\\u003ePackages + to install on the host when registered. Can be set by `host_packages` parameter, + example: `pkg1 pkg2`\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"update_packages\",\"full_name\":\"registration_command[update_packages]\",\"description\":\"\\n\\u003cp\\u003eUpdate + all packages on the host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repo\",\"full_name\":\"registration_command[repo]\",\"description\":\"\\n\\u003cp\\u003eRepository + URL / details, for example for Debian OS family: \\u0026#39;deb \\u003ca href=\\\"http://deb.example.com\\\"\\u003edeb.example.com\\u003c/a\\u003e/ + buster 1.0\\u0026#39;, for Red Hat and SUSE OS family: \\u0026#39;\\u003ca + href=\\\"http://yum.theforeman.org/client/latest/el8/x86_64\\\"\\u003eyum.theforeman.org/client/latest/el8/x86_64\\u003c/a\\u003e/\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repo_gpg_key_url\",\"full_name\":\"registration_command[repo_gpg_key_url]\",\"description\":\"\\n\\u003cp\\u003eURL + of the GPG key for the repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"remote_execution_interface\",\"full_name\":\"registration_command[remote_execution_interface]\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the Host interface for Remote execution\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"setup_remote_execution_pull\",\"full_name\":\"registration_command[setup_remote_execution_pull]\",\"description\":\"\\n\\u003cp\\u003eSet + \\u0026#39;host_registration_remote_execution_pull\\u0026#39; parameter for + the host. If it is set to true, pull provider client will be deployed on the + host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"activation_key\",\"full_name\":\"registration_command[activation_key]\",\"description\":\"\\n\\u003cp\\u003eActivation + key for subscription-manager client, required for CentOS and Red Hat Enterprise + Linux. For multiple keys use `activation_keys` param instead.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":true},{\"name\":\"activation_keys\",\"full_name\":\"registration_command[activation_keys]\",\"description\":\"\\n\\u003cp\\u003eActivation + keys for subscription-manager client, required for CentOS and Red Hat Enterprise + Linux. Required only if host group has no activation keys.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lifecycle_environment_id\",\"full_name\":\"registration_command[lifecycle_environment_id]\",\"description\":\"\\n\\u003cp\\u003eLifecycle + environment for the host.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"force\",\"full_name\":\"registration_command[force]\",\"description\":\"\\n\\u003cp\\u003eClear + any previous registration and run subscription-manager with \u2013force.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ignore_subman_errors\",\"full_name\":\"registration_command[ignore_subman_errors]\",\"description\":\"\\n\\u003cp\\u003eIgnore + subscription-manager errors for `subscription-manager register` command\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"hosts\":{\"doc_url\":\"/apidoc/v2/hosts\",\"id\":\"hosts\",\"api_url\":\"/api\",\"name\":\"Hosts\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/hosts/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/hosts\",\"http_method\":\"GET\",\"short_description\":\"List + all hosts\",\"deprecated\":null},{\"api_url\":\"/api/hostgroups/:hostgroup_id/hosts\",\"http_method\":\"GET\",\"short_description\":\"List + all hosts for a host group\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/hosts\",\"http_method\":\"GET\",\"short_description\":\"List + hosts per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/hosts\",\"http_method\":\"GET\",\"short_description\":\"List + hosts per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"thin\",\"full_name\":\"thin\",\"description\":\"\\n\\u003cp\\u003eOnly + list ID and name of hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eID + of location\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of organization\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include\",\"full_name\":\"include\",\"description\":\"\\n\\u003cp\\u003eArray + of extra information types to include\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eparameters\\u003c/code\\u003e, \\u003ccode\\u003eall_parameters\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"activation_key\",\"type\":\"string\"},{\"name\":\"activation_key_id\",\"type\":\"string\"},{\"name\":\"addon\",\"type\":\"string\"},{\"name\":\"addons_status\",\"values\":[\"mismatched\",\"matched\",\"not_specified\"]},{\"name\":\"ansible_role\",\"type\":\"string\"},{\"name\":\"applicable_debs\",\"type\":\"string\"},{\"name\":\"applicable_errata\",\"type\":\"string\"},{\"name\":\"applicable_errata_issued\",\"type\":\"date\"},{\"name\":\"applicable_rpms\",\"type\":\"string\"},{\"name\":\"architecture\",\"type\":\"string\"},{\"name\":\"autoheal\",\"type\":\"boolean\"},{\"name\":\"boot_time\",\"type\":\"\"},{\"name\":\"build\",\"values\":[\"true\",\"false\"]},{\"name\":\"build_status\",\"values\":[\"built\",\"pending\",\"token_expired\",\"build_failed\"]},{\"name\":\"comment\",\"type\":\"text\"},{\"name\":\"compute_resource\",\"type\":\"string\"},{\"name\":\"compute_resource_id\",\"type\":\"integer\"},{\"name\":\"configuration_status.applied\",\"type\":\"integer\"},{\"name\":\"configuration_status.enabled\",\"values\":[\"true\",\"false\"]},{\"name\":\"configuration_status.failed\",\"type\":\"integer\"},{\"name\":\"configuration_status.failed_restarts\",\"type\":\"integer\"},{\"name\":\"configuration_status.interesting\",\"values\":[\"true\",\"false\"]},{\"name\":\"configuration_status.pending\",\"type\":\"integer\"},{\"name\":\"configuration_status.restarted\",\"type\":\"integer\"},{\"name\":\"configuration_status.skipped\",\"type\":\"integer\"},{\"name\":\"content_source\",\"type\":\"string\"},{\"name\":\"content_views\",\"type\":\"string\"},{\"name\":\"created_at\",\"type\":\"datetime\"},{\"name\":\"cve_id\",\"type\":\"integer\"},{\"name\":\"domain\",\"type\":\"string\"},{\"name\":\"domain_id\",\"type\":\"integer\"},{\"name\":\"errata_status\",\"values\":[\"security_needed\",\"errata_needed\",\"updated\",\"unknown\"]},{\"name\":\"execution_status\",\"values\":[\"ok\",\"error\"]},{\"name\":\"facts\",\"type\":\"string\"},{\"name\":\"global_status\",\"values\":[\"ok\",\"warning\",\"error\"]},{\"name\":\"has_ip\",\"type\":\"string\"},{\"name\":\"has_ip6\",\"type\":\"string\"},{\"name\":\"has_mac\",\"type\":\"string\"},{\"name\":\"hostgroup\",\"type\":\"string\"},{\"name\":\"hostgroup_fullname\",\"type\":\"string\"},{\"name\":\"hostgroup_id\",\"type\":\"integer\"},{\"name\":\"hostgroup_name\",\"type\":\"string\"},{\"name\":\"hostgroup_title\",\"type\":\"string\"},{\"name\":\"hypervisor\",\"type\":\"boolean\"},{\"name\":\"hypervisor_host\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"image\",\"type\":\"string\"},{\"name\":\"infrastructure_facet.foreman\",\"values\":[\"true\",\"false\"]},{\"name\":\"infrastructure_facet.smart_proxy_id\",\"type\":\"\"},{\"name\":\"insights_client_report_status\",\"values\":[\"reporting\",\"no_report\"]},{\"name\":\"insights_inventory_sync_status\",\"values\":[\"disconnect\",\"sync\"]},{\"name\":\"insights_recommendations_count\",\"type\":\"integer\"},{\"name\":\"installable_errata\",\"type\":\"string\"},{\"name\":\"installed_at\",\"type\":\"datetime\"},{\"name\":\"ip\",\"type\":\"string\"},{\"name\":\"ip6\",\"type\":\"string\"},{\"name\":\"job_invocation.id\",\"type\":\"string\"},{\"name\":\"job_invocation.result\",\"values\":[\"cancelled\",\"failed\",\"pending\",\"success\"]},{\"name\":\"last_checkin\",\"type\":\"datetime\"},{\"name\":\"last_report\",\"type\":\"datetime\"},{\"name\":\"lifecycle_environments\",\"type\":\"string\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"mac\",\"type\":\"string\"},{\"name\":\"managed\",\"values\":[\"true\",\"false\"]},{\"name\":\"model\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"origin\",\"type\":\"string\"},{\"name\":\"os\",\"type\":\"string\"},{\"name\":\"os_description\",\"type\":\"string\"},{\"name\":\"os_id\",\"type\":\"integer\"},{\"name\":\"os_major\",\"type\":\"string\"},{\"name\":\"os_minor\",\"type\":\"string\"},{\"name\":\"os_title\",\"type\":\"string\"},{\"name\":\"owner\",\"type\":\"string\"},{\"name\":\"owner_id\",\"type\":\"integer\"},{\"name\":\"owner_type\",\"type\":\"string\"},{\"name\":\"params\",\"type\":\"string\"},{\"name\":\"params_name\",\"type\":\"string\"},{\"name\":\"parent_hostgroup\",\"type\":\"string\"},{\"name\":\"puppet_ca\",\"type\":\"string\"},{\"name\":\"puppet_proxy_id\",\"type\":\"integer\"},{\"name\":\"puppetmaster\",\"type\":\"string\"},{\"name\":\"purpose_status\",\"values\":[\"mismatched\",\"matched\",\"not_specified\"]},{\"name\":\"pxe_loader\",\"values\":[\"PXELinux_BIOS\",\"PXELinux_UEFI\",\"Grub_UEFI\",\"Grub2_BIOS\",\"Grub2_ELF\",\"Grub2_UEFI\",\"Grub2_UEFI_SecureBoot\",\"Grub2_UEFI_HTTP\",\"Grub2_UEFI_HTTPS\",\"Grub2_UEFI_HTTPS_SecureBoot\",\"iPXE_Embedded\",\"iPXE_UEFI_HTTP\",\"iPXE_Chain_BIOS\",\"iPXE_Chain_UEFI\"]},{\"name\":\"realm\",\"type\":\"string\"},{\"name\":\"realm_id\",\"type\":\"integer\"},{\"name\":\"registered_at\",\"type\":\"datetime\"},{\"name\":\"registered_through\",\"type\":\"string\"},{\"name\":\"release_version\",\"type\":\"string\"},{\"name\":\"reported.bios_release_date\",\"type\":\"\"},{\"name\":\"reported.bios_vendor\",\"type\":\"\"},{\"name\":\"reported.bios_version\",\"type\":\"\"},{\"name\":\"reported.boot_time\",\"type\":\"\"},{\"name\":\"reported.cores\",\"type\":\"\"},{\"name\":\"reported.disks_total\",\"type\":\"\"},{\"name\":\"reported.kernel_version\",\"type\":\"\"},{\"name\":\"reported.ram\",\"type\":\"\"},{\"name\":\"reported.sockets\",\"type\":\"\"},{\"name\":\"reported.virtual\",\"values\":[\"true\",\"false\"]},{\"name\":\"repository\",\"type\":\"string\"},{\"name\":\"repository_content_label\",\"type\":\"string\"},{\"name\":\"rhel_lifecycle_status\",\"values\":[\"full_support\",\"maintenance_support\",\"approaching_end_of_maintenance\",\"extended_support\",\"approaching_end_of_support\",\"support_ended\"]},{\"name\":\"role\",\"type\":\"text\"},{\"name\":\"role_status\",\"values\":[\"mismatched\",\"matched\",\"not_specified\"]},{\"name\":\"service_level\",\"type\":\"string\"},{\"name\":\"sla_status\",\"values\":[\"mismatched\",\"matched\",\"not_specified\"]},{\"name\":\"smart_proxy\",\"type\":\"string\"},{\"name\":\"status.applied\",\"type\":\"integer\"},{\"name\":\"status.enabled\",\"values\":[\"true\",\"false\"]},{\"name\":\"status.failed\",\"type\":\"integer\"},{\"name\":\"status.failed_restarts\",\"type\":\"integer\"},{\"name\":\"status.interesting\",\"values\":[\"true\",\"false\"]},{\"name\":\"status.pending\",\"type\":\"integer\"},{\"name\":\"status.restarted\",\"type\":\"integer\"},{\"name\":\"status.skipped\",\"type\":\"integer\"},{\"name\":\"subnet\",\"type\":\"string\"},{\"name\":\"subnet.name\",\"type\":\"text\"},{\"name\":\"subnet6\",\"type\":\"string\"},{\"name\":\"subnet6.name\",\"type\":\"text\"},{\"name\":\"subscription_id\",\"type\":\"string\"},{\"name\":\"subscription_name\",\"type\":\"string\"},{\"name\":\"subscription_status\",\"values\":[\"valid\",\"partial\",\"invalid\",\"unknown\",\"disabled\",\"unsubscribed_hypervisor\"]},{\"name\":\"subscription_uuid\",\"type\":\"string\"},{\"name\":\"trace_status\",\"values\":[\"reboot_needed\",\"process_restart_needed\",\"updated\"]},{\"name\":\"upgradable_debs\",\"type\":\"string\"},{\"name\":\"upgradable_rpms\",\"type\":\"string\"},{\"name\":\"usage\",\"type\":\"text\"},{\"name\":\"usage_status\",\"values\":[\"mismatched\",\"matched\",\"not_specified\"]},{\"name\":\"user.firstname\",\"type\":\"string\"},{\"name\":\"user.lastname\",\"type\":\"string\"},{\"name\":\"user.login\",\"type\":\"string\"},{\"name\":\"user.mail\",\"type\":\"string\"},{\"name\":\"usergroup\",\"type\":\"string\"},{\"name\":\"usergroup.name\",\"type\":\"string\"},{\"name\":\"uuid\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/hosts/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"show_hidden_parameters\",\"full_name\":\"show_hidden_parameters\",\"description\":\"\\n\\u003cp\\u003eDisplay + hidden parameter values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/hosts\",\"http_method\":\"POST\",\"short_description\":\"Create + a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host\",\"full_name\":\"host\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"host[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"host[location_id]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"host[organization_id]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip\",\"full_name\":\"host[ip]\",\"description\":\"\\n\\u003cp\\u003enot + required if using a subnet with DHCP Capsule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mac\",\"full_name\":\"host[mac]\",\"description\":\"\\n\\u003cp\\u003erequired + for managed host that is bare metal, not required if it\\u0026#39;s a virtual + machine\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_id\",\"full_name\":\"host[architecture_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"host[domain_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_id\",\"full_name\":\"host[realm_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"puppet_proxy_id\",\"full_name\":\"host[puppet_proxy_id]\",\"description\":\"\\n\\u003cp\\u003ePuppet + Capsule ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"puppet_ca_proxy_id\",\"full_name\":\"host[puppet_ca_proxy_id]\",\"description\":\"\\n\\u003cp\\u003ePuppet + CA Capsule ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"openscap_proxy_id\",\"full_name\":\"host[openscap_proxy_id]\",\"description\":\"\\n\\u003cp\\u003eID + of OpenSCAP Capsule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"host[operatingsystem_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_id\",\"full_name\":\"host[medium_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if not imaged based provisioning and host is managed and value is not inherited + from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"pxe_loader\",\"full_name\":\"host[pxe_loader]\",\"description\":\"\\n\\u003cp\\u003eDHCP + filename option (Grub2/PXELinux by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eNone\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux + BIOS\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub UEFI\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 BIOS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 ELF\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 + UEFI HTTP\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI HTTPS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI HTTPS SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Embedded\\u003c/code\\u003e, \\u003ccode\\u003eiPXE UEFI HTTP\\u003c/code\\u003e, + \\u003ccode\\u003eiPXE Chain BIOS\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Chain UEFI\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_id\",\"full_name\":\"host[ptable_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and custom partition has not been defined\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"host[subnet_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"host[compute_resource_id]\",\"description\":\"\\n\\u003cp\\u003enil + means host is bare metal\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"root_pass\",\"full_name\":\"host[root_pass]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group or default password + in settings\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"model_id\",\"full_name\":\"host[model_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"host[hostgroup_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"owner_id\",\"full_name\":\"host[owner_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"owner_type\",\"full_name\":\"host[owner_type]\",\"description\":\"\\n\\u003cp\\u003eHost\\u0026#39;s + owner type\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eUser\\u003c/code\\u003e, \\u003ccode\\u003eUsergroup\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"image_id\",\"full_name\":\"host[image_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_parameters_attributes\",\"full_name\":\"host[host_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eHost\\u0026#39;s + parameters (array or indexed hash)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"host[host_parameters_attributes][name]\",\"description\":\"\\n\\u003cp\\u003eName + of the parameter\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"host[host_parameters_attributes][value]\",\"description\":\"\\n\\u003cp\\u003eParameter + value\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter_type\",\"full_name\":\"host[host_parameters_attributes][parameter_type]\",\"description\":\"\\n\\u003cp\\u003eType + of value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"host[host_parameters_attributes][hidden_value]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"build\",\"full_name\":\"host[build]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"host[enabled]\",\"description\":\"\\n\\u003cp\\u003eInclude + this host within Satellite reporting\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provision_method\",\"full_name\":\"host[provision_method]\",\"description\":\"\\n\\u003cp\\u003eThe + method used to provision the host.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ebuild\\u003c/code\\u003e, \\u003ccode\\u003eimage\\u003c/code\\u003e, + \\u003ccode\\u003ebootdisk\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"managed\",\"full_name\":\"host[managed]\",\"description\":\"\\n\\u003cp\\u003eTrue/False + flag whether a host is managed or unmanaged. Note: this value also determines + whether several parameters are required or not\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"progress_report_id\",\"full_name\":\"host[progress_report_id]\",\"description\":\"\\n\\u003cp\\u003eUUID + to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"comment\",\"full_name\":\"host[comment]\",\"description\":\"\\n\\u003cp\\u003eAdditional + information about this host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"capabilities\",\"full_name\":\"host[capabilities]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_profile_id\",\"full_name\":\"host[compute_profile_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interfaces_attributes\",\"full_name\":\"host[interfaces_attributes]\",\"description\":\"\\n\\u003cp\\u003eHost\\u0026#39;s + network interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"id\",\"full_name\":\"host[interfaces_attributes][id]\",\"description\":\"\\n\\u003cp\\u003eID + of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mac\",\"full_name\":\"host[interfaces_attributes][mac]\",\"description\":\"\\n\\u003cp\\u003eMAC + address of interface. Required for managed interfaces on bare metal.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip\",\"full_name\":\"host[interfaces_attributes][ip]\",\"description\":\"\\n\\u003cp\\u003eIPv4 + address of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip6\",\"full_name\":\"host[interfaces_attributes][ip6]\",\"description\":\"\\n\\u003cp\\u003eIPv6 + address of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"host[interfaces_attributes][type]\",\"description\":\"\\n\\u003cp\\u003eInterface + type, e.g. bmc. Default is interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003einterface\\u003c/code\\u003e, \\u003ccode\\u003ebmc\\u003c/code\\u003e, + \\u003ccode\\u003ebond\\u003c/code\\u003e, \\u003ccode\\u003ebridge\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"host[interfaces_attributes][name]\",\"description\":\"\\n\\u003cp\\u003eInterface\\u0026#39;s + DNS name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"host[interfaces_attributes][subnet_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + subnet ID of IPv4 interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet6_id\",\"full_name\":\"host[interfaces_attributes][subnet6_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + subnet ID of IPv6 interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"host[interfaces_attributes][domain_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + domain ID of interface. Required for primary interfaces on managed hosts.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"identifier\",\"full_name\":\"host[interfaces_attributes][identifier]\",\"description\":\"\\n\\u003cp\\u003eDevice + identifier, e.g. eth0 or eth1.1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"managed\",\"full_name\":\"host[interfaces_attributes][managed]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be managed via DHCP and DNS capsule and should it be configured + during provisioning?\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"primary\",\"full_name\":\"host[interfaces_attributes][primary]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for constructing the FQDN of the host? Each managed + hosts needs to have one primary interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provision\",\"full_name\":\"host[interfaces_attributes][provision]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? + Each managed hosts needs to have one provision interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"username\",\"full_name\":\"host[interfaces_attributes][username]\",\"description\":\"\\n\\u003cp\\u003eOnly + for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"host[interfaces_attributes][password]\",\"description\":\"\\n\\u003cp\\u003eOnly + for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provider\",\"full_name\":\"host[interfaces_attributes][provider]\",\"description\":\"\\n\\u003cp\\u003eInterface + provider, e.g. IPMI. Only for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eIPMI\\u003c/code\\u003e, \\u003ccode\\u003eRedfish\\u003c/code\\u003e, + \\u003ccode\\u003eSSH\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"virtual\",\"full_name\":\"host[interfaces_attributes][virtual]\",\"description\":\"\\n\\u003cp\\u003eAlias + or VLAN device\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tag\",\"full_name\":\"host[interfaces_attributes][tag]\",\"description\":\"\\n\\u003cp\\u003eVLAN + tag, this attribute has precedence over the subnet VLAN ID. Only for virtual + interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mtu\",\"full_name\":\"host[interfaces_attributes][mtu]\",\"description\":\"\\n\\u003cp\\u003eMTU, + this attribute has precedence over the subnet MTU.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attached_to\",\"full_name\":\"host[interfaces_attributes][attached_to]\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the interface to which this interface belongs, e.g. eth1. Only for virtual + interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mode\",\"full_name\":\"host[interfaces_attributes][mode]\",\"description\":\"\\n\\u003cp\\u003eBond + mode of the interface, e.g. balance-rr. Only for bond interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ebalance-rr\\u003c/code\\u003e, \\u003ccode\\u003eactive-backup\\u003c/code\\u003e, + \\u003ccode\\u003ebalance-xor\\u003c/code\\u003e, \\u003ccode\\u003ebroadcast\\u003c/code\\u003e, + \\u003ccode\\u003e802.3ad\\u003c/code\\u003e, \\u003ccode\\u003ebalance-tlb\\u003c/code\\u003e, + \\u003ccode\\u003ebalance-alb\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attached_devices\",\"full_name\":\"host[interfaces_attributes][attached_devices]\",\"description\":\"\\n\\u003cp\\u003eIdentifiers + of attached interfaces, e.g. `[\\u0026#39;eth1\\u0026#39;, \\u0026#39;eth2\\u0026#39;]`. + For bond interfaces those are the slaves. Only for bond and bridges interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"bond_options\",\"full_name\":\"host[interfaces_attributes][bond_options]\",\"description\":\"\\n\\u003cp\\u003eSpace + separated options, e.g. miimon=100. Only for bond interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_attributes\",\"full_name\":\"host[interfaces_attributes][compute_attributes]\",\"description\":\"\\n\\u003cp\\u003eAdditional + compute resource specific attributes for the interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"compute_attributes\",\"full_name\":\"host[compute_attributes]\",\"description\":\"\\n\\u003cp\\u003eAdditional + compute resource specific attributes.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_facet_attributes\",\"full_name\":\"host[content_facet_attributes]\",\"description\":\"\\n\\u003cp\\u003eParameters + for host\\u0026#39;s content_facet facet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"content_view_id\",\"full_name\":\"host[content_facet_attributes][content_view_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lifecycle_environment_id\",\"full_name\":\"host[content_facet_attributes][lifecycle_environment_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_source_id\",\"full_name\":\"host[content_facet_attributes][content_source_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"kickstart_repository_id\",\"full_name\":\"host[content_facet_attributes][kickstart_repository_id]\",\"description\":\"\\n\\u003cp\\u003eRepository + Id associated with the kickstart repo used for provisioning\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"subscription_facet_attributes\",\"full_name\":\"host[subscription_facet_attributes]\",\"description\":\"\\n\\u003cp\\u003eParameters + for host\\u0026#39;s subscription_facet facet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"release_version\",\"full_name\":\"host[subscription_facet_attributes][release_version]\",\"description\":\"\\n\\u003cp\\u003eRelease + version for this Host to use (7Server, 7.1, etc)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"autoheal\",\"full_name\":\"host[subscription_facet_attributes][autoheal]\",\"description\":\"\\n\\u003cp\\u003eSets + whether the Host will autoheal subscriptions upon checkin\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_usage\",\"full_name\":\"host[subscription_facet_attributes][purpose_usage]\",\"description\":\"\\n\\u003cp\\u003eSets + the system purpose usage\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_role\",\"full_name\":\"host[subscription_facet_attributes][purpose_role]\",\"description\":\"\\n\\u003cp\\u003eSets + the system purpose usage\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_addons\",\"full_name\":\"host[subscription_facet_attributes][purpose_addons]\",\"description\":\"\\n\\u003cp\\u003eSets + the system add-ons\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"service_level\",\"full_name\":\"host[subscription_facet_attributes][service_level]\",\"description\":\"\\n\\u003cp\\u003eService + level to be used for autoheal\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_guest_uuids\",\"full_name\":\"host[subscription_facet_attributes][hypervisor_guest_uuids]\",\"description\":\"\\n\\u003cp\\u003eList + of hypervisor guest uuids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"installed_products_attributes\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes]\",\"description\":\"\\n\\u003cp\\u003eList + of products installed on the host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"product_id\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][product_id]\",\"description\":\"\\n\\u003cp\\u003eProduct + id as listed from a host\\u0026#39;s installed products, this is not + the same product id as the products api returns\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_name\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][product_name]\",\"description\":\"\\n\\u003cp\\u003eProduct + name as listed from a host\\u0026#39;s installed products\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"arch\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][arch]\",\"description\":\"\\n\\u003cp\\u003eProduct + architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][version]\",\"description\":\"\\n\\u003cp\\u003eProduct + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}]},{\"name\":\"overwrite\",\"full_name\":\"host[overwrite]\",\"description\":\"\\n\\u003cp\\u003eOverwrite + existing host (true by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_role_ids\",\"full_name\":\"host[ansible_role_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated ansible roles\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/hosts/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host\",\"full_name\":\"host\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"host[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"host[location_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"host[organization_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip\",\"full_name\":\"host[ip]\",\"description\":\"\\n\\u003cp\\u003enot + required if using a subnet with DHCP Capsule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mac\",\"full_name\":\"host[mac]\",\"description\":\"\\n\\u003cp\\u003erequired + for managed host that is bare metal, not required if it\\u0026#39;s a virtual + machine\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_id\",\"full_name\":\"host[architecture_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"host[domain_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_id\",\"full_name\":\"host[realm_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"puppet_proxy_id\",\"full_name\":\"host[puppet_proxy_id]\",\"description\":\"\\n\\u003cp\\u003ePuppet + Capsule ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"puppet_ca_proxy_id\",\"full_name\":\"host[puppet_ca_proxy_id]\",\"description\":\"\\n\\u003cp\\u003ePuppet + CA Capsule ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"openscap_proxy_id\",\"full_name\":\"host[openscap_proxy_id]\",\"description\":\"\\n\\u003cp\\u003eID + of OpenSCAP Capsule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"host[operatingsystem_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_id\",\"full_name\":\"host[medium_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if not imaged based provisioning and host is managed and value is not inherited + from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"pxe_loader\",\"full_name\":\"host[pxe_loader]\",\"description\":\"\\n\\u003cp\\u003eDHCP + filename option (Grub2/PXELinux by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eNone\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux + BIOS\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub UEFI\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 BIOS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 ELF\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 + UEFI HTTP\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI HTTPS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI HTTPS SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Embedded\\u003c/code\\u003e, \\u003ccode\\u003eiPXE UEFI HTTP\\u003c/code\\u003e, + \\u003ccode\\u003eiPXE Chain BIOS\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Chain UEFI\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_id\",\"full_name\":\"host[ptable_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and custom partition has not been defined\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"host[subnet_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"host[compute_resource_id]\",\"description\":\"\\n\\u003cp\\u003enil + means host is bare metal\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"root_pass\",\"full_name\":\"host[root_pass]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group or default password + in settings\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"model_id\",\"full_name\":\"host[model_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"host[hostgroup_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"owner_id\",\"full_name\":\"host[owner_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"owner_type\",\"full_name\":\"host[owner_type]\",\"description\":\"\\n\\u003cp\\u003eHost\\u0026#39;s + owner type\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eUser\\u003c/code\\u003e, \\u003ccode\\u003eUsergroup\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"image_id\",\"full_name\":\"host[image_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_parameters_attributes\",\"full_name\":\"host[host_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eHost\\u0026#39;s + parameters (array or indexed hash)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"host[host_parameters_attributes][name]\",\"description\":\"\\n\\u003cp\\u003eName + of the parameter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"host[host_parameters_attributes][value]\",\"description\":\"\\n\\u003cp\\u003eParameter + value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter_type\",\"full_name\":\"host[host_parameters_attributes][parameter_type]\",\"description\":\"\\n\\u003cp\\u003eType + of value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"host[host_parameters_attributes][hidden_value]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"build\",\"full_name\":\"host[build]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"host[enabled]\",\"description\":\"\\n\\u003cp\\u003eInclude + this host within Satellite reporting\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provision_method\",\"full_name\":\"host[provision_method]\",\"description\":\"\\n\\u003cp\\u003eThe + method used to provision the host.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ebuild\\u003c/code\\u003e, \\u003ccode\\u003eimage\\u003c/code\\u003e, + \\u003ccode\\u003ebootdisk\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"managed\",\"full_name\":\"host[managed]\",\"description\":\"\\n\\u003cp\\u003eTrue/False + flag whether a host is managed or unmanaged. Note: this value also determines + whether several parameters are required or not\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"progress_report_id\",\"full_name\":\"host[progress_report_id]\",\"description\":\"\\n\\u003cp\\u003eUUID + to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"comment\",\"full_name\":\"host[comment]\",\"description\":\"\\n\\u003cp\\u003eAdditional + information about this host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"capabilities\",\"full_name\":\"host[capabilities]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_profile_id\",\"full_name\":\"host[compute_profile_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interfaces_attributes\",\"full_name\":\"host[interfaces_attributes]\",\"description\":\"\\n\\u003cp\\u003eHost\\u0026#39;s + network interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"id\",\"full_name\":\"host[interfaces_attributes][id]\",\"description\":\"\\n\\u003cp\\u003eID + of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mac\",\"full_name\":\"host[interfaces_attributes][mac]\",\"description\":\"\\n\\u003cp\\u003eMAC + address of interface. Required for managed interfaces on bare metal.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip\",\"full_name\":\"host[interfaces_attributes][ip]\",\"description\":\"\\n\\u003cp\\u003eIPv4 + address of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip6\",\"full_name\":\"host[interfaces_attributes][ip6]\",\"description\":\"\\n\\u003cp\\u003eIPv6 + address of interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"host[interfaces_attributes][type]\",\"description\":\"\\n\\u003cp\\u003eInterface + type, e.g. bmc. Default is interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003einterface\\u003c/code\\u003e, \\u003ccode\\u003ebmc\\u003c/code\\u003e, + \\u003ccode\\u003ebond\\u003c/code\\u003e, \\u003ccode\\u003ebridge\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"host[interfaces_attributes][name]\",\"description\":\"\\n\\u003cp\\u003eInterface\\u0026#39;s + DNS name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"host[interfaces_attributes][subnet_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + subnet ID of IPv4 interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet6_id\",\"full_name\":\"host[interfaces_attributes][subnet6_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + subnet ID of IPv6 interface\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"host[interfaces_attributes][domain_id]\",\"description\":\"\\n\\u003cp\\u003eSatellite + domain ID of interface. Required for primary interfaces on managed hosts.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"identifier\",\"full_name\":\"host[interfaces_attributes][identifier]\",\"description\":\"\\n\\u003cp\\u003eDevice + identifier, e.g. eth0 or eth1.1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"managed\",\"full_name\":\"host[interfaces_attributes][managed]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be managed via DHCP and DNS capsule and should it be configured + during provisioning?\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"primary\",\"full_name\":\"host[interfaces_attributes][primary]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for constructing the FQDN of the host? Each managed + hosts needs to have one primary interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provision\",\"full_name\":\"host[interfaces_attributes][provision]\",\"description\":\"\\n\\u003cp\\u003eShould + this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? + Each managed hosts needs to have one provision interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"username\",\"full_name\":\"host[interfaces_attributes][username]\",\"description\":\"\\n\\u003cp\\u003eOnly + for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"host[interfaces_attributes][password]\",\"description\":\"\\n\\u003cp\\u003eOnly + for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provider\",\"full_name\":\"host[interfaces_attributes][provider]\",\"description\":\"\\n\\u003cp\\u003eInterface + provider, e.g. IPMI. Only for BMC interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eIPMI\\u003c/code\\u003e, \\u003ccode\\u003eRedfish\\u003c/code\\u003e, + \\u003ccode\\u003eSSH\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"virtual\",\"full_name\":\"host[interfaces_attributes][virtual]\",\"description\":\"\\n\\u003cp\\u003eAlias + or VLAN device\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tag\",\"full_name\":\"host[interfaces_attributes][tag]\",\"description\":\"\\n\\u003cp\\u003eVLAN + tag, this attribute has precedence over the subnet VLAN ID. Only for virtual + interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mtu\",\"full_name\":\"host[interfaces_attributes][mtu]\",\"description\":\"\\n\\u003cp\\u003eMTU, + this attribute has precedence over the subnet MTU.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attached_to\",\"full_name\":\"host[interfaces_attributes][attached_to]\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the interface to which this interface belongs, e.g. eth1. Only for virtual + interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mode\",\"full_name\":\"host[interfaces_attributes][mode]\",\"description\":\"\\n\\u003cp\\u003eBond + mode of the interface, e.g. balance-rr. Only for bond interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ebalance-rr\\u003c/code\\u003e, \\u003ccode\\u003eactive-backup\\u003c/code\\u003e, + \\u003ccode\\u003ebalance-xor\\u003c/code\\u003e, \\u003ccode\\u003ebroadcast\\u003c/code\\u003e, + \\u003ccode\\u003e802.3ad\\u003c/code\\u003e, \\u003ccode\\u003ebalance-tlb\\u003c/code\\u003e, + \\u003ccode\\u003ebalance-alb\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attached_devices\",\"full_name\":\"host[interfaces_attributes][attached_devices]\",\"description\":\"\\n\\u003cp\\u003eIdentifiers + of attached interfaces, e.g. `[\\u0026#39;eth1\\u0026#39;, \\u0026#39;eth2\\u0026#39;]`. + For bond interfaces those are the slaves. Only for bond and bridges interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"bond_options\",\"full_name\":\"host[interfaces_attributes][bond_options]\",\"description\":\"\\n\\u003cp\\u003eSpace + separated options, e.g. miimon=100. Only for bond interfaces.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_attributes\",\"full_name\":\"host[interfaces_attributes][compute_attributes]\",\"description\":\"\\n\\u003cp\\u003eAdditional + compute resource specific attributes for the interface.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"compute_attributes\",\"full_name\":\"host[compute_attributes]\",\"description\":\"\\n\\u003cp\\u003eAdditional + compute resource specific attributes.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_facet_attributes\",\"full_name\":\"host[content_facet_attributes]\",\"description\":\"\\n\\u003cp\\u003eParameters + for host\\u0026#39;s content_facet facet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"content_view_id\",\"full_name\":\"host[content_facet_attributes][content_view_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lifecycle_environment_id\",\"full_name\":\"host[content_facet_attributes][lifecycle_environment_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_source_id\",\"full_name\":\"host[content_facet_attributes][content_source_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"kickstart_repository_id\",\"full_name\":\"host[content_facet_attributes][kickstart_repository_id]\",\"description\":\"\\n\\u003cp\\u003eRepository + Id associated with the kickstart repo used for provisioning\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"subscription_facet_attributes\",\"full_name\":\"host[subscription_facet_attributes]\",\"description\":\"\\n\\u003cp\\u003eParameters + for host\\u0026#39;s subscription_facet facet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"release_version\",\"full_name\":\"host[subscription_facet_attributes][release_version]\",\"description\":\"\\n\\u003cp\\u003eRelease + version for this Host to use (7Server, 7.1, etc)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"autoheal\",\"full_name\":\"host[subscription_facet_attributes][autoheal]\",\"description\":\"\\n\\u003cp\\u003eSets + whether the Host will autoheal subscriptions upon checkin\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_usage\",\"full_name\":\"host[subscription_facet_attributes][purpose_usage]\",\"description\":\"\\n\\u003cp\\u003eSets + the system purpose usage\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_role\",\"full_name\":\"host[subscription_facet_attributes][purpose_role]\",\"description\":\"\\n\\u003cp\\u003eSets + the system purpose usage\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_addons\",\"full_name\":\"host[subscription_facet_attributes][purpose_addons]\",\"description\":\"\\n\\u003cp\\u003eSets + the system add-ons\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"service_level\",\"full_name\":\"host[subscription_facet_attributes][service_level]\",\"description\":\"\\n\\u003cp\\u003eService + level to be used for autoheal\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_guest_uuids\",\"full_name\":\"host[subscription_facet_attributes][hypervisor_guest_uuids]\",\"description\":\"\\n\\u003cp\\u003eList + of hypervisor guest uuids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"installed_products_attributes\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes]\",\"description\":\"\\n\\u003cp\\u003eList + of products installed on the host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"product_id\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][product_id]\",\"description\":\"\\n\\u003cp\\u003eProduct + id as listed from a host\\u0026#39;s installed products, this is not + the same product id as the products api returns\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_name\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][product_name]\",\"description\":\"\\n\\u003cp\\u003eProduct + name as listed from a host\\u0026#39;s installed products\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"arch\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][arch]\",\"description\":\"\\n\\u003cp\\u003eProduct + architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"host[subscription_facet_attributes][installed_products_attributes][version]\",\"description\":\"\\n\\u003cp\\u003eProduct + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}]},{\"name\":\"ansible_role_ids\",\"full_name\":\"host[ansible_role_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated ansible roles\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/hosts/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/enc\",\"name\":\"enc\",\"apis\":[{\"api_url\":\"/api/hosts/:id/enc\",\"http_method\":\"GET\",\"short_description\":\"Get + ENC values of host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/get_status\",\"name\":\"get_status\",\"apis\":[{\"api_url\":\"/api/hosts/:id/status/:type\",\"http_method\":\"GET\",\"short_description\":\"Get + status of host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eReturns + string representing a host status of a given type\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"type\",\"description\":\"\\n\\u003cp\\u003estatus + type, can be one of\\u003c/p\\u003e\\n\\u003cul\\u003e\\u003cli\\u003e\\n\\u003cp\\u003eglobal\\u003c/p\\u003e\\n\\u003c/li\\u003e\\u003cli\\u003e\\n\\u003cp\\u003econfiguration\\u003c/p\\u003e\\n\\u003c/li\\u003e\\u003cli\\u003e\\n\\u003cp\\u003ebuild\\u003c/p\\u003e\\n\\u003c/li\\u003e\\u003c/ul\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eHostStatus::Global\\u003c/code\\u003e, \\u003ccode\\u003econfiguration\\u003c/code\\u003e, + \\u003ccode\\u003ebuild\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/forget_status\",\"name\":\"forget_status\",\"apis\":[{\"api_url\":\"/api/hosts/:id/status/:type\",\"http_method\":\"DELETE\",\"short_description\":\"Clear + sub-status of host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eClears + a host sub-status of a given type\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"type\",\"description\":\"\\n\\u003cp\\u003estatus + type\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003econfiguration\\u003c/code\\u003e, \\u003ccode\\u003ebuild\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/vm_compute_attributes\",\"name\":\"vm_compute_attributes\",\"apis\":[{\"api_url\":\"/api/hosts/:id/vm_compute_attributes\",\"http_method\":\"GET\",\"short_description\":\"Get + vm attributes of host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eReturn + the host\\u0026#39;s compute attributes that can be used to create a clone + of this VM\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/disassociate\",\"name\":\"disassociate\",\"apis\":[{\"api_url\":\"/api/hosts/:id/disassociate\",\"http_method\":\"PUT\",\"short_description\":\"Disassociate + the host from a VM\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/power\",\"name\":\"power\",\"apis\":[{\"api_url\":\"/api/hosts/:id/power\",\"http_method\":\"PUT\",\"short_description\":\"Run + a power operation on host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"power_action\",\"full_name\":\"power_action\",\"description\":\"\\n\\u003cp\\u003epower + action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), + (state/status)\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/power_status\",\"name\":\"power_status\",\"apis\":[{\"api_url\":\"/api/hosts/:id/power\",\"http_method\":\"GET\",\"short_description\":\"Fetch + the status of whether the host is powered on or not. Supported hosts are VMs + and physical hosts with BMCs.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"timeout\",\"full_name\":\"timeout\",\"description\":\"\\n\\u003cp\\u003eTimeout + to retrieve the power status of the host in seconds. Default is 3 seconds.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/boot\",\"name\":\"boot\",\"apis\":[{\"api_url\":\"/api/hosts/:id/boot\",\"http_method\":\"PUT\",\"short_description\":\"Boot + host from specified device\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"device\",\"full_name\":\"device\",\"description\":\"\\n\\u003cp\\u003eboot + device, valid devices are disk, cdrom, pxe, bios\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/facts\",\"name\":\"facts\",\"apis\":[{\"api_url\":\"/api/hosts/facts\",\"http_method\":\"POST\",\"short_description\":\"Upload + facts for a host, creating the host if required\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003ehostname + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"facts\",\"full_name\":\"facts\",\"description\":\"\\n\\u003cp\\u003ehash + containing the facts for the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"certname\",\"full_name\":\"certname\",\"description\":\"\\n\\u003cp\\u003eoptional: + certname of the host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"type\",\"description\":\"\\n\\u003cp\\u003eoptional: + the STI type of host to create\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/rebuild_config\",\"name\":\"rebuild_config\",\"apis\":[{\"api_url\":\"/api/hosts/:id/rebuild_config\",\"http_method\":\"PUT\",\"short_description\":\"Rebuild + orchestration config\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"only\",\"full_name\":\"only\",\"description\":\"\\n\\u003cp\\u003eLimit + rebuild steps, valid steps are DHCP, DNS, TFTP, Content_Host_Status, Refresh_Content_Host_Status\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/template\",\"name\":\"template\",\"apis\":[{\"api_url\":\"/api/hosts/:id/template/:kind\",\"http_method\":\"GET\",\"short_description\":\"Preview + rendered provisioning template content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"kind\",\"full_name\":\"kind\",\"description\":\"\\n\\u003cp\\u003eTemplate + kinds, available values: Bootdisk, PXELinux, PXEGrub, PXEGrub2, iPXE, provision, + finish, script, user_data, ZTP, POAP, cloud-init, host_init_config, registration, + kexec\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/templates\",\"name\":\"templates\",\"apis\":[{\"api_url\":\"/api/hosts/:id/templates\",\"http_method\":\"GET\",\"short_description\":\"Get + provisioning templates for the host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/inherited_parameters\",\"name\":\"inherited_parameters\",\"apis\":[{\"api_url\":\"/api/hosts/:id/inherited_parameters\",\"http_method\":\"GET\",\"short_description\":\"Get + all inherited parameters for a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/play_roles\",\"name\":\"play_roles\",\"apis\":[{\"api_url\":\"/api/hosts/:id/play_roles\",\"http_method\":\"POST\",\"short_description\":\"Runs + all Ansible roles on a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/multiple_play_roles\",\"name\":\"multiple_play_roles\",\"apis\":[{\"api_url\":\"/api/hosts/multiple_play_roles\",\"http_method\":\"POST\",\"short_description\":\"Runs + all Ansible roles on hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"host_ids\",\"description\":\"\\n\\u003cp\\u003eIDs + of hosts to play roles on\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/ansible_roles\",\"name\":\"ansible_roles\",\"apis\":[{\"api_url\":\"/api/hosts/:id/ansible_roles\",\"http_method\":\"GET\",\"short_description\":\"List + all Ansible roles for a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/assign_ansible_roles\",\"name\":\"assign_ansible_roles\",\"apis\":[{\"api_url\":\"/api/hosts/:id/assign_ansible_roles\",\"http_method\":\"POST\",\"short_description\":\"Assigns + Ansible roles to a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_role_ids\",\"full_name\":\"ansible_role_ids\",\"description\":\"\\n\\u003cp\\u003eAnsible + roles to assign to a host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/add_ansible_role\",\"name\":\"add_ansible_role\",\"apis\":[{\"api_url\":\"/api/hosts/:id/ansible_roles/:ansible_role_id\",\"http_method\":\"PUT\",\"short_description\":\"Directly + add an Ansible role to a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_role_id\",\"full_name\":\"ansible_role_id\",\"description\":\"\\n\\u003cp\\u003eAnsible + role to add to a host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/remove_ansible_role\",\"name\":\"remove_ansible_role\",\"apis\":[{\"api_url\":\"/api/hosts/:id/ansible_roles/:ansible_role_id\",\"http_method\":\"DELETE\",\"short_description\":\"Remove + directly assigned Ansible role from a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_role_id\",\"full_name\":\"ansible_role_id\",\"description\":\"\\n\\u003cp\\u003eAnsible + role to remove from a host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/host_collections\",\"name\":\"host_collections\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/host_collections\",\"http_method\":\"PUT\",\"short_description\":\"Alter + a host's host collections\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eThe + id of the host to alter\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_collection_ids\",\"full_name\":\"host_collection_ids\",\"description\":\"\\n\\u003cp\\u003eList + of host collection ids to update\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts/policies_enc\",\"name\":\"policies_enc\",\"apis\":[{\"api_url\":\"/api/hosts/:id/policies_enc\",\"http_method\":\"GET\",\"short_description\":\"Show + config information for foreman_scap_client\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eThe + identifier of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"hostgroups\":{\"doc_url\":\"/apidoc/v2/hostgroups\",\"id\":\"hostgroups\",\"api_url\":\"/api\",\"name\":\"Hostgroups\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/hostgroups/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/hostgroups\",\"http_method\":\"GET\",\"short_description\":\"List + all host groups\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/hostgroups\",\"http_method\":\"GET\",\"short_description\":\"List + all host groups per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/hostgroups\",\"http_method\":\"GET\",\"short_description\":\"List + all host groups per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include\",\"full_name\":\"include\",\"description\":\"\\n\\u003cp\\u003eArray + of extra information types to include\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of [\\\"parameters\\\"]\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"ansible_role\",\"type\":\"string\"},{\"name\":\"architecture\",\"type\":\"string\"},{\"name\":\"host\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"label\",\"type\":\"string\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"medium\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"os\",\"type\":\"string\"},{\"name\":\"os_description\",\"type\":\"string\"},{\"name\":\"os_id\",\"type\":\"integer\"},{\"name\":\"os_major\",\"type\":\"string\"},{\"name\":\"os_minor\",\"type\":\"string\"},{\"name\":\"os_title\",\"type\":\"string\"},{\"name\":\"oval_policy_id\",\"type\":\"string\"},{\"name\":\"params\",\"type\":\"string\"},{\"name\":\"template\",\"type\":\"string\"},{\"name\":\"title\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/hostgroups/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a host group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"show_hidden_parameters\",\"full_name\":\"show_hidden_parameters\",\"description\":\"\\n\\u003cp\\u003eDisplay + hidden parameter values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/hostgroups\",\"http_method\":\"POST\",\"short_description\":\"Create + a host group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup\",\"full_name\":\"hostgroup\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"hostgroup[name]\",\"description\":\"\\n\\u003cp\\u003eName + of the host group\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"hostgroup[description]\",\"description\":\"\\n\\u003cp\\u003eHost + group description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parent_id\",\"full_name\":\"hostgroup[parent_id]\",\"description\":\"\\n\\u003cp\\u003eParent + ID of the host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_profile_id\",\"full_name\":\"hostgroup[compute_profile_id]\",\"description\":\"\\n\\u003cp\\u003eCompute + profile ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"hostgroup[compute_resource_id]\",\"description\":\"\\n\\u003cp\\u003eCompute + resource ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"hostgroup[operatingsystem_id]\",\"description\":\"\\n\\u003cp\\u003eOperating + system ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_id\",\"full_name\":\"hostgroup[architecture_id]\",\"description\":\"\\n\\u003cp\\u003eArchitecture + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"pxe_loader\",\"full_name\":\"hostgroup[pxe_loader]\",\"description\":\"\\n\\u003cp\\u003eDHCP + filename option (Grub2/PXELinux by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eNone\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux + BIOS\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub UEFI\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 BIOS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 ELF\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 + UEFI HTTP\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI HTTPS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI HTTPS SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Embedded\\u003c/code\\u003e, \\u003ccode\\u003eiPXE UEFI HTTP\\u003c/code\\u003e, + \\u003ccode\\u003eiPXE Chain BIOS\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Chain UEFI\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_id\",\"full_name\":\"hostgroup[medium_id]\",\"description\":\"\\n\\u003cp\\u003eMedia + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_id\",\"full_name\":\"hostgroup[ptable_id]\",\"description\":\"\\n\\u003cp\\u003ePartition + table ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"hostgroup[subnet_id]\",\"description\":\"\\n\\u003cp\\u003eSubnet + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet6_id\",\"full_name\":\"hostgroup[subnet6_id]\",\"description\":\"\\n\\u003cp\\u003eSubnet + IPv6 ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"hostgroup[domain_id]\",\"description\":\"\\n\\u003cp\\u003eDomain + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_id\",\"full_name\":\"hostgroup[realm_id]\",\"description\":\"\\n\\u003cp\\u003eRealm + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"group_parameters_attributes\",\"full_name\":\"hostgroup[group_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eArray + of parameters\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"hostgroup[group_parameters_attributes][name]\",\"description\":\"\\n\\u003cp\\u003eName + of the parameter\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"hostgroup[group_parameters_attributes][value]\",\"description\":\"\\n\\u003cp\\u003eParameter + value\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter_type\",\"full_name\":\"hostgroup[group_parameters_attributes][parameter_type]\",\"description\":\"\\n\\u003cp\\u003eType + of value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"hostgroup[group_parameters_attributes][hidden_value]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"puppet_proxy_id\",\"full_name\":\"hostgroup[puppet_proxy_id]\",\"description\":\"\\n\\u003cp\\u003ePuppet + Capsule ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"puppet_ca_proxy_id\",\"full_name\":\"hostgroup[puppet_ca_proxy_id]\",\"description\":\"\\n\\u003cp\\u003ePuppet + CA Capsule ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"openscap_proxy_id\",\"full_name\":\"hostgroup[openscap_proxy_id]\",\"description\":\"\\n\\u003cp\\u003eID + of OpenSCAP Capsule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"root_pass\",\"full_name\":\"hostgroup[root_pass]\",\"description\":\"\\n\\u003cp\\u003eRoot + password on provisioned hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"hostgroup[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"hostgroup[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_role_ids\",\"full_name\":\"hostgroup[ansible_role_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated ansible roles\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_source_id\",\"full_name\":\"hostgroup[content_source_id]\",\"description\":\"\\n\\u003cp\\u003eContent + source ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"hostgroup[content_view_id]\",\"description\":\"\\n\\u003cp\\u003eContent + view ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lifecycle_environment_id\",\"full_name\":\"hostgroup[lifecycle_environment_id]\",\"description\":\"\\n\\u003cp\\u003eLifecycle + environment ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"kickstart_repository_id\",\"full_name\":\"hostgroup[kickstart_repository_id]\",\"description\":\"\\n\\u003cp\\u003eKickstart + repository ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/hostgroups/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a host group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup\",\"full_name\":\"hostgroup\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"hostgroup[name]\",\"description\":\"\\n\\u003cp\\u003eName + of the host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"hostgroup[description]\",\"description\":\"\\n\\u003cp\\u003eHost + group description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parent_id\",\"full_name\":\"hostgroup[parent_id]\",\"description\":\"\\n\\u003cp\\u003eParent + ID of the host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_profile_id\",\"full_name\":\"hostgroup[compute_profile_id]\",\"description\":\"\\n\\u003cp\\u003eCompute + profile ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"hostgroup[compute_resource_id]\",\"description\":\"\\n\\u003cp\\u003eCompute + resource ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"hostgroup[operatingsystem_id]\",\"description\":\"\\n\\u003cp\\u003eOperating + system ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_id\",\"full_name\":\"hostgroup[architecture_id]\",\"description\":\"\\n\\u003cp\\u003eArchitecture + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"pxe_loader\",\"full_name\":\"hostgroup[pxe_loader]\",\"description\":\"\\n\\u003cp\\u003eDHCP + filename option (Grub2/PXELinux by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eNone\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux + BIOS\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub UEFI\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 BIOS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 ELF\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 + UEFI HTTP\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI HTTPS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI HTTPS SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Embedded\\u003c/code\\u003e, \\u003ccode\\u003eiPXE UEFI HTTP\\u003c/code\\u003e, + \\u003ccode\\u003eiPXE Chain BIOS\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Chain UEFI\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_id\",\"full_name\":\"hostgroup[medium_id]\",\"description\":\"\\n\\u003cp\\u003eMedia + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_id\",\"full_name\":\"hostgroup[ptable_id]\",\"description\":\"\\n\\u003cp\\u003ePartition + table ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"hostgroup[subnet_id]\",\"description\":\"\\n\\u003cp\\u003eSubnet + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet6_id\",\"full_name\":\"hostgroup[subnet6_id]\",\"description\":\"\\n\\u003cp\\u003eSubnet + IPv6 ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"hostgroup[domain_id]\",\"description\":\"\\n\\u003cp\\u003eDomain + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_id\",\"full_name\":\"hostgroup[realm_id]\",\"description\":\"\\n\\u003cp\\u003eRealm + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"group_parameters_attributes\",\"full_name\":\"hostgroup[group_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eArray + of parameters\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"hostgroup[group_parameters_attributes][name]\",\"description\":\"\\n\\u003cp\\u003eName + of the parameter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"hostgroup[group_parameters_attributes][value]\",\"description\":\"\\n\\u003cp\\u003eParameter + value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter_type\",\"full_name\":\"hostgroup[group_parameters_attributes][parameter_type]\",\"description\":\"\\n\\u003cp\\u003eType + of value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"hostgroup[group_parameters_attributes][hidden_value]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"puppet_proxy_id\",\"full_name\":\"hostgroup[puppet_proxy_id]\",\"description\":\"\\n\\u003cp\\u003ePuppet + Capsule ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"puppet_ca_proxy_id\",\"full_name\":\"hostgroup[puppet_ca_proxy_id]\",\"description\":\"\\n\\u003cp\\u003ePuppet + CA Capsule ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"openscap_proxy_id\",\"full_name\":\"hostgroup[openscap_proxy_id]\",\"description\":\"\\n\\u003cp\\u003eID + of OpenSCAP Capsule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"root_pass\",\"full_name\":\"hostgroup[root_pass]\",\"description\":\"\\n\\u003cp\\u003eRoot + password on provisioned hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"hostgroup[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"hostgroup[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_role_ids\",\"full_name\":\"hostgroup[ansible_role_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated ansible roles\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_source_id\",\"full_name\":\"hostgroup[content_source_id]\",\"description\":\"\\n\\u003cp\\u003eContent + source ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"hostgroup[content_view_id]\",\"description\":\"\\n\\u003cp\\u003eContent + view ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lifecycle_environment_id\",\"full_name\":\"hostgroup[lifecycle_environment_id]\",\"description\":\"\\n\\u003cp\\u003eLifecycle + environment ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"kickstart_repository_id\",\"full_name\":\"hostgroup[kickstart_repository_id]\",\"description\":\"\\n\\u003cp\\u003eKickstart + repository ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/hostgroups/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a host group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/clone\",\"name\":\"clone\",\"apis\":[{\"api_url\":\"/api/hostgroups/:id/clone\",\"http_method\":\"POST\",\"short_description\":\"Clone + a host group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/rebuild_config\",\"name\":\"rebuild_config\",\"apis\":[{\"api_url\":\"/api/hostgroups/:id/rebuild_config\",\"http_method\":\"PUT\",\"short_description\":\"Rebuild + orchestration config\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"only\",\"full_name\":\"only\",\"description\":\"\\n\\u003cp\\u003eLimit + rebuild steps, valid steps are DHCP, DNS, TFTP, Content_Host_Status, Refresh_Content_Host_Status\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"children_hosts\",\"full_name\":\"children_hosts\",\"description\":\"\\n\\u003cp\\u003eOperate + on child hostgroup hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/play_roles\",\"name\":\"play_roles\",\"apis\":[{\"api_url\":\"/api/hostgroups/:id/play_roles\",\"http_method\":\"POST\",\"short_description\":\"Runs + all Ansible roles on a hostgroup\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/multiple_play_roles\",\"name\":\"multiple_play_roles\",\"apis\":[{\"api_url\":\"/api/hostgroups/multiple_play_roles\",\"http_method\":\"POST\",\"short_description\":\"Runs + all Ansible roles on hostgroups\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_ids\",\"full_name\":\"hostgroup_ids\",\"description\":\"\\n\\u003cp\\u003eIDs + of hostgroups to play roles on\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/ansible_roles\",\"name\":\"ansible_roles\",\"apis\":[{\"api_url\":\"/api/hostgroups/:id/ansible_roles\",\"http_method\":\"GET\",\"short_description\":\"List + all Ansible roles for a hostgroup\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/assign_ansible_roles\",\"name\":\"assign_ansible_roles\",\"apis\":[{\"api_url\":\"/api/hostgroups/:id/assign_ansible_roles\",\"http_method\":\"POST\",\"short_description\":\"Assigns + Ansible roles to a hostgroup\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_role_ids\",\"full_name\":\"ansible_role_ids\",\"description\":\"\\n\\u003cp\\u003eAnsible + roles to assign to a hostgroup\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/add_ansible_role\",\"name\":\"add_ansible_role\",\"apis\":[{\"api_url\":\"/api/hostgroups/:id/ansible_roles/:ansible_role_id\",\"http_method\":\"PUT\",\"short_description\":\"Directly + add an Ansible role to a hostgroup\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_role_id\",\"full_name\":\"ansible_role_id\",\"description\":\"\\n\\u003cp\\u003eAnsible + role to add to a hostgroup\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hostgroups/remove_ansible_role\",\"name\":\"remove_ansible_role\",\"apis\":[{\"api_url\":\"/api/hostgroups/:id/ansible_roles/:ansible_role_id\",\"http_method\":\"DELETE\",\"short_description\":\"Remove + directly assigned Ansible role from a hostgroup\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_role_id\",\"full_name\":\"ansible_role_id\",\"description\":\"\\n\\u003cp\\u003eAnsible + role to remove from a hostgroup\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"job_templates\":{\"doc_url\":\"/apidoc/v2/job_templates\",\"id\":\"job_templates\",\"api_url\":\"/api\",\"name\":\"Job_templates\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/job_templates/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/job_templates\",\"http_method\":\"GET\",\"short_description\":\"List + job templates\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/job_templates\",\"http_method\":\"GET\",\"short_description\":\"List + job templates per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/job_templates\",\"http_method\":\"GET\",\"short_description\":\"List + job templates per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_templates/import\",\"name\":\"import\",\"apis\":[{\"api_url\":\"/api/job_templates/import\",\"http_method\":\"POST\",\"short_description\":\"Import + a job template from ERB\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"template\",\"description\":\"\\n\\u003cp\\u003eTemplate + ERB\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"overwrite\",\"full_name\":\"overwrite\",\"description\":\"\\n\\u003cp\\u003eOverwrite + template if it already exists\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_templates/export\",\"name\":\"export\",\"apis\":[{\"api_url\":\"/api/job_templates/:id/export\",\"http_method\":\"GET\",\"short_description\":\"Export + a job template to ERB\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_templates/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/job_templates/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + job template details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_templates/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/job_templates\",\"http_method\":\"POST\",\"short_description\":\"Create + a job template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"job_template\",\"full_name\":\"job_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"job_template[name]\",\"description\":\"\\n\\u003cp\\u003eTemplate + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"job_template[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"job_category\",\"full_name\":\"job_template[job_category]\",\"description\":\"\\n\\u003cp\\u003eJob + category\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description_format\",\"full_name\":\"job_template[description_format]\",\"description\":\"\\n\\u003cp\\u003eThis + template is used to generate the description. Input values can be used using + the syntax %{package}. You may also include the job category and template + name using %{job_category} and %{template_name}.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"job_template[template]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provider_type\",\"full_name\":\"job_template[provider_type]\",\"description\":\"\\n\\u003cp\\u003eProvider + type\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eSSH\\u003c/code\\u003e, \\u003ccode\\u003escript\\u003c/code\\u003e, + \\u003ccode\\u003eAnsible\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"snippet\",\"full_name\":\"job_template[snippet]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"audit_comment\",\"full_name\":\"job_template[audit_comment]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locked\",\"full_name\":\"job_template[locked]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is locked for editing\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"effective_user_attributes\",\"full_name\":\"job_template[effective_user_attributes]\",\"description\":\"\\n\\u003cp\\u003eEffective + user options\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"value\",\"full_name\":\"job_template[effective_user_attributes][value]\",\"description\":\"\\n\\u003cp\\u003eWhat + user should be used to run the script (using sudo-like mechanisms)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"overridable\",\"full_name\":\"job_template[effective_user_attributes][overridable]\",\"description\":\"\\n\\u003cp\\u003eWhether + it should be allowed to override the effective user from the invocation form.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"current_user\",\"full_name\":\"job_template[effective_user_attributes][current_user]\",\"description\":\"\\n\\u003cp\\u003eWhether + the current user login should be used as the effective user\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"location_ids\",\"full_name\":\"job_template[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"job_template[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_callback_enabled\",\"full_name\":\"job_template[ansible_callback_enabled]\",\"description\":\"\\n\\u003cp\\u003eEnable + the callback plugin for this template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_templates/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/job_templates/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a job template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"job_template\",\"full_name\":\"job_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"job_template[name]\",\"description\":\"\\n\\u003cp\\u003eTemplate + name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"job_template[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"job_category\",\"full_name\":\"job_template[job_category]\",\"description\":\"\\n\\u003cp\\u003eJob + category\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description_format\",\"full_name\":\"job_template[description_format]\",\"description\":\"\\n\\u003cp\\u003eThis + template is used to generate the description. Input values can be used using + the syntax %{package}. You may also include the job category and template + name using %{job_category} and %{template_name}.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"job_template[template]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provider_type\",\"full_name\":\"job_template[provider_type]\",\"description\":\"\\n\\u003cp\\u003eProvider + type\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eSSH\\u003c/code\\u003e, \\u003ccode\\u003escript\\u003c/code\\u003e, + \\u003ccode\\u003eAnsible\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"snippet\",\"full_name\":\"job_template[snippet]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"audit_comment\",\"full_name\":\"job_template[audit_comment]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locked\",\"full_name\":\"job_template[locked]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is locked for editing\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"effective_user_attributes\",\"full_name\":\"job_template[effective_user_attributes]\",\"description\":\"\\n\\u003cp\\u003eEffective + user options\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"value\",\"full_name\":\"job_template[effective_user_attributes][value]\",\"description\":\"\\n\\u003cp\\u003eWhat + user should be used to run the script (using sudo-like mechanisms)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"overridable\",\"full_name\":\"job_template[effective_user_attributes][overridable]\",\"description\":\"\\n\\u003cp\\u003eWhether + it should be allowed to override the effective user from the invocation form.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"current_user\",\"full_name\":\"job_template[effective_user_attributes][current_user]\",\"description\":\"\\n\\u003cp\\u003eWhether + the current user login should be used as the effective user\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"location_ids\",\"full_name\":\"job_template[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"job_template[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_callback_enabled\",\"full_name\":\"job_template[ansible_callback_enabled]\",\"description\":\"\\n\\u003cp\\u003eEnable + the callback plugin for this template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_templates/revision\",\"name\":\"revision\",\"apis\":[{\"api_url\":\"/api/job_templates/revision\",\"http_method\":\"GET\",\"short_description\":null,\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"version\",\"description\":\"\\n\\u003cp\\u003eTemplate + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_templates/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/job_templates/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a job template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_templates/clone\",\"name\":\"clone\",\"apis\":[{\"api_url\":\"/api/job_templates/:id/clone\",\"http_method\":\"POST\",\"short_description\":\"Clone + a provision template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"job_template\",\"full_name\":\"job_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"job_template[name]\",\"description\":\"\\n\\u003cp\\u003eTemplate + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"hosts_bulk_actions\":{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions\",\"id\":\"hosts_bulk_actions\",\"api_url\":\"/api\",\"name\":\"Hosts_bulk_actions\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/bulk_destroy\",\"name\":\"bulk_destroy\",\"apis\":[{\"api_url\":\"/api/hosts/bulk\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + multiple hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\\n\\u003cp\\u003eHosts + to include in the action\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string describing which hosts to perform the action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform the action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\\n\\u003cp\\u003eHosts + to explicitly exclude in the action. All other hosts will be included in the + action, unless an included parameter is passed as well.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not perform the action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/bulk_add_host_collections\",\"name\":\"bulk_add_host_collections\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/add_host_collections\",\"http_method\":\"PUT\",\"short_description\":\"Add + one or more host collections to one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"host_collection_ids\",\"full_name\":\"host_collection_ids\",\"description\":\"\\n\\u003cp\\u003eList + of host collection ids\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/bulk_remove_host_collections\",\"name\":\"bulk_remove_host_collections\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/remove_host_collections\",\"http_method\":\"PUT\",\"short_description\":\"Remove + one or more host collections from one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"host_collection_ids\",\"full_name\":\"host_collection_ids\",\"description\":\"\\n\\u003cp\\u003eList + of host collection ids\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/applicable_errata\",\"name\":\"applicable_errata\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/applicable_errata\",\"http_method\":\"POST\",\"short_description\":\"Fetch + applicable errata for one or more hosts.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/installable_errata\",\"name\":\"installable_errata\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/installable_errata\",\"http_method\":\"POST\",\"short_description\":\"Fetch + installable errata for one or more hosts.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/destroy_hosts\",\"name\":\"destroy_hosts\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/destroy\",\"http_method\":\"PUT\",\"short_description\":\"Destroy + one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/remove_subscriptions\",\"name\":\"remove_subscriptions\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/remove_subscriptions\",\"http_method\":\"PUT\",\"short_description\":\"Remove + subscriptions from one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"subscriptions\",\"full_name\":\"subscriptions\",\"description\":\"\\n\\u003cp\\u003eArray + of subscriptions to remove\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"id\",\"full_name\":\"subscriptions[id]\",\"description\":\"\\n\\u003cp\\u003eSubscription + Pool id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"quantity\",\"full_name\":\"subscriptions[quantity]\",\"description\":\"\\n\\u003cp\\u003eQuantity + of specified subscription to remove\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/add_subscriptions\",\"name\":\"add_subscriptions\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/add_subscriptions\",\"http_method\":\"PUT\",\"short_description\":\"Add + subscriptions to one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"subscriptions\",\"full_name\":\"subscriptions\",\"description\":\"\\n\\u003cp\\u003eArray + of subscriptions to add\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"id\",\"full_name\":\"subscriptions[id]\",\"description\":\"\\n\\u003cp\\u003eSubscription + Pool id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"quantity\",\"full_name\":\"subscriptions[quantity]\",\"description\":\"\\n\\u003cp\\u003eQuantity + of this subscriptions to add\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/auto_attach\",\"name\":\"auto_attach\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/auto_attach\",\"http_method\":\"PUT\",\"short_description\":\"Trigger + an auto-attach of subscriptions on one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/content_overrides\",\"name\":\"content_overrides\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/content_overrides\",\"http_method\":\"PUT\",\"short_description\":\"Set + content overrides to one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"content_overrides\",\"full_name\":\"content_overrides\",\"description\":\"\\n\\u003cp\\u003eArray + of Content override parameters\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"content_label\",\"full_name\":\"content_overrides[content_label]\",\"description\":\"\\n\\u003cp\\u003eLabel + of the content\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"content_overrides[value]\",\"description\":\"\\n\\u003cp\\u003eOverride + value. Provide a boolean value if name is \\u0026#39;enabled\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"content_overrides[name]\",\"description\":\"\\n\\u003cp\\u003eOverride + key or name. Note if name is not provided the default name will be \\u0026#39;enabled\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"remove\",\"full_name\":\"content_overrides[remove]\",\"description\":\"\\n\\u003cp\\u003eSet + true to remove an override and reset it to \\u0026#39;default\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/environment_content_view\",\"name\":\"environment_content_view\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/environment_content_view\",\"http_method\":\"PUT\",\"short_description\":\"Assign + the environment and content view to one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/release_version\",\"name\":\"release_version\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/release_version\",\"http_method\":\"PUT\",\"short_description\":\"Assign + the release version to one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"release_version\",\"full_name\":\"release_version\",\"description\":\"\\n\\u003cp\\u003econtent + release version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/traces\",\"name\":\"traces\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/traces\",\"http_method\":\"POST\",\"short_description\":\"Fetch + traces for one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/resolve_traces\",\"name\":\"resolve_traces\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/resolve_traces\",\"http_method\":\"PUT\",\"short_description\":\"Resolve + traces for one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"trace_ids\",\"full_name\":\"trace_ids\",\"description\":\"\\n\\u003cp\\u003eArray + of Trace IDs\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/system_purpose\",\"name\":\"system_purpose\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/system_purpose\",\"http_method\":\"PUT\",\"short_description\":\"Assign + system purpose attributes on one or more hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"service_level\",\"full_name\":\"service_level\",\"description\":\"\\n\\u003cp\\u003eService + level of host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_role\",\"full_name\":\"purpose_role\",\"description\":\"\\n\\u003cp\\u003eRole + of host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_usage\",\"full_name\":\"purpose_usage\",\"description\":\"\\n\\u003cp\\u003eUsage + of host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_addons\",\"full_name\":\"purpose_addons\",\"description\":\"\\n\\u003cp\\u003eSets + the system add-ons\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/available_incremental_updates\",\"name\":\"available_incremental_updates\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/available_incremental_updates\",\"http_method\":\"POST\",\"short_description\":\"Given + a set of hosts and errata, lists the content view versions and environments + that need updating.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"errata_ids\",\"full_name\":\"errata_ids\",\"description\":\"\\n\\u003cp\\u003eList + of Errata ids\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/module_streams\",\"name\":\"module_streams\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/module_streams\",\"http_method\":\"POST\",\"short_description\":\"Fetch + available module streams for hosts.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for hosts to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/hosts_bulk_actions/change_content_source\",\"name\":\"change_content_source\",\"apis\":[{\"api_url\":\"/api/hosts/bulk/change_content_source\",\"http_method\":\"PUT\",\"short_description\":\"Update + the content source for specified hosts and generate the reconfiguration script\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"host_ids\",\"description\":\"\\n\\u003cp\\u003eThe + ids of the hosts to alter. Hosts not managed by Katello are ignored\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eThe + id of the lifecycle environment\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003eThe + id of the content view\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_source_id\",\"full_name\":\"content_source_id\",\"description\":\"\\n\\u003cp\\u003eThe + id of the content source\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"smart_proxies\":{\"doc_url\":\"/apidoc/v2/smart_proxies\",\"id\":\"smart_proxies\",\"api_url\":\"/api\",\"name\":\"Smart_proxies\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/smart_proxies/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/smart_proxies\",\"http_method\":\"GET\",\"short_description\":\"List + all capsules\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_status\",\"full_name\":\"include_status\",\"description\":\"\\n\\u003cp\\u003eFlag + to indicate whether to include status or not\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"feature\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"url\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/smart_proxies/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/smart_proxies/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_status\",\"full_name\":\"include_status\",\"description\":\"\\n\\u003cp\\u003eFlag + to indicate whether to include status or not\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_version\",\"full_name\":\"include_version\",\"description\":\"\\n\\u003cp\\u003eFlag + to indicate whether to include version or not\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/smart_proxies/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/smart_proxies\",\"http_method\":\"POST\",\"short_description\":\"Create + a capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy\",\"full_name\":\"smart_proxy\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"smart_proxy[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"smart_proxy[url]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"smart_proxy[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"smart_proxy[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"download_policy\",\"full_name\":\"smart_proxy[download_policy]\",\"description\":\"\\n\\u003cp\\u003eDownload + Policy of the capsule, must be one of on_demand, immediate, inherit, streamed\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy_id\",\"full_name\":\"smart_proxy[http_proxy_id]\",\"description\":\"\\n\\u003cp\\u003eId + of the HTTP Proxy to use with alternate content sources\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/smart_proxies/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/smart_proxies/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy\",\"full_name\":\"smart_proxy\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"smart_proxy[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"smart_proxy[url]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"smart_proxy[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"smart_proxy[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"download_policy\",\"full_name\":\"smart_proxy[download_policy]\",\"description\":\"\\n\\u003cp\\u003eDownload + Policy of the capsule, must be one of on_demand, immediate, inherit, streamed\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy_id\",\"full_name\":\"smart_proxy[http_proxy_id]\",\"description\":\"\\n\\u003cp\\u003eId + of the HTTP Proxy to use with alternate content sources\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/smart_proxies/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/smart_proxies/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/smart_proxies/refresh\",\"name\":\"refresh\",\"apis\":[{\"api_url\":\"/api/smart_proxies/:id/refresh\",\"http_method\":\"PUT\",\"short_description\":\"Refresh + capsule features\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/smart_proxies/import_subnets\",\"name\":\"import_subnets\",\"apis\":[{\"api_url\":\"/api/smart_proxies/:id/import_subnets\",\"http_method\":\"POST\",\"short_description\":\"Import + subnets from Capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"compute_resources\":{\"doc_url\":\"/apidoc/v2/compute_resources\",\"id\":\"compute_resources\",\"api_url\":\"/api\",\"name\":\"Compute_resources\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/compute_resources/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/compute_resources\",\"http_method\":\"GET\",\"short_description\":\"List + all compute resources\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"type\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/compute_resources\",\"http_method\":\"POST\",\"short_description\":\"Create + a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource\",\"full_name\":\"compute_resource\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"compute_resource[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provider\",\"full_name\":\"compute_resource[provider]\",\"description\":\"\\n\\u003cp\\u003eProviders + include Libvirt, Ovirt, EC2, Vmware, Openstack, AzureRm, GCE\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"compute_resource[url]\",\"description\":\"\\n\\u003cp\\u003eURL + for Libvirt, RHEV and RHEL OpenStack Platform\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"compute_resource[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user\",\"full_name\":\"compute_resource[user]\",\"description\":\"\\n\\u003cp\\u003eUsername + for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key for EC2.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"compute_resource[password]\",\"description\":\"\\n\\u003cp\\u003ePassword + for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"datacenter\",\"full_name\":\"compute_resource[datacenter]\",\"description\":\"\\n\\u003cp\\u003efor + RHEV, VMware Datacenter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ovirt_quota\",\"full_name\":\"compute_resource[ovirt_quota]\",\"description\":\"\\n\\u003cp\\u003efor + RHEV only, ID or Name of quota to use\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"public_key\",\"full_name\":\"compute_resource[public_key]\",\"description\":\"\\n\\u003cp\\u003efor + RHEV only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"region\",\"full_name\":\"compute_resource[region]\",\"description\":\"\\n\\u003cp\\u003efor + AzureRm eg. \\u0026#39;eastus\\u0026#39; and for EC2 only. Use \\u0026#39;us-gov-west-1\\u0026#39; + for EC2 GovCloud region\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tenant\",\"full_name\":\"compute_resource[tenant]\",\"description\":\"\\n\\u003cp\\u003efor + RHEL OpenStack Platform and AzureRm only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain\",\"full_name\":\"compute_resource[domain]\",\"description\":\"\\n\\u003cp\\u003efor + RHEL OpenStack Platform (v3) only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"project_domain_name\",\"full_name\":\"compute_resource[project_domain_name]\",\"description\":\"\\n\\u003cp\\u003efor + RHEL OpenStack Platform (v3) only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"project_domain_id\",\"full_name\":\"compute_resource[project_domain_id]\",\"description\":\"\\n\\u003cp\\u003efor + RHEL OpenStack Platform (v3) only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"server\",\"full_name\":\"compute_resource[server]\",\"description\":\"\\n\\u003cp\\u003efor + VMware\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"set_console_password\",\"full_name\":\"compute_resource[set_console_password]\",\"description\":\"\\n\\u003cp\\u003efor + Libvirt and VMware only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"display_type\",\"full_name\":\"compute_resource[display_type]\",\"description\":\"\\n\\u003cp\\u003efor + Libvirt and RHEV only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eVNC\\u003c/code\\u003e, \\u003ccode\\u003eSPICE\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"keyboard_layout\",\"full_name\":\"compute_resource[keyboard_layout]\",\"description\":\"\\n\\u003cp\\u003efor + RHEV only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ear\\u003c/code\\u003e, \\u003ccode\\u003ede-ch\\u003c/code\\u003e, + \\u003ccode\\u003ees\\u003c/code\\u003e, \\u003ccode\\u003efo\\u003c/code\\u003e, + \\u003ccode\\u003efr-ca\\u003c/code\\u003e, \\u003ccode\\u003ehu\\u003c/code\\u003e, + \\u003ccode\\u003eja\\u003c/code\\u003e, \\u003ccode\\u003emk\\u003c/code\\u003e, + \\u003ccode\\u003eno\\u003c/code\\u003e, \\u003ccode\\u003ept-br\\u003c/code\\u003e, + \\u003ccode\\u003esv\\u003c/code\\u003e, \\u003ccode\\u003eda\\u003c/code\\u003e, + \\u003ccode\\u003een-gb\\u003c/code\\u003e, \\u003ccode\\u003eet\\u003c/code\\u003e, + \\u003ccode\\u003efr\\u003c/code\\u003e, \\u003ccode\\u003efr-ch\\u003c/code\\u003e, + \\u003ccode\\u003eis\\u003c/code\\u003e, \\u003ccode\\u003elt\\u003c/code\\u003e, + \\u003ccode\\u003enl\\u003c/code\\u003e, \\u003ccode\\u003epl\\u003c/code\\u003e, + \\u003ccode\\u003eru\\u003c/code\\u003e, \\u003ccode\\u003eth\\u003c/code\\u003e, + \\u003ccode\\u003ede\\u003c/code\\u003e, \\u003ccode\\u003een-us\\u003c/code\\u003e, + \\u003ccode\\u003efi\\u003c/code\\u003e, \\u003ccode\\u003efr-be\\u003c/code\\u003e, + \\u003ccode\\u003ehr\\u003c/code\\u003e, \\u003ccode\\u003eit\\u003c/code\\u003e, + \\u003ccode\\u003elv\\u003c/code\\u003e, \\u003ccode\\u003enl-be\\u003c/code\\u003e, + \\u003ccode\\u003ept\\u003c/code\\u003e, \\u003ccode\\u003esl\\u003c/code\\u003e, + \\u003ccode\\u003etr\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"caching_enabled\",\"full_name\":\"compute_resource[caching_enabled]\",\"description\":\"\\n\\u003cp\\u003eenable + caching, for VMware only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"compute_resource[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"compute_resource[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"app_ident\",\"full_name\":\"compute_resource[app_ident]\",\"description\":\"\\n\\u003cp\\u003eClient + ID for AzureRm\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"secret_key\",\"full_name\":\"compute_resource[secret_key]\",\"description\":\"\\n\\u003cp\\u003eClient + Secret for AzureRm\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sub_id\",\"full_name\":\"compute_resource[sub_id]\",\"description\":\"\\n\\u003cp\\u003eSubscription + ID for AzureRm\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cloud\",\"full_name\":\"compute_resource[cloud]\",\"description\":\"\\n\\u003cp\\u003eCloud\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"key_path\",\"full_name\":\"compute_resource[key_path]\",\"description\":\"\\n\\u003cp\\u003eCertificate + path, for GCE only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"zone\",\"full_name\":\"compute_resource[zone]\",\"description\":\"\\n\\u003cp\\u003eZone, + for GCE only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"project\",\"full_name\":\"compute_resource[project]\",\"description\":\"\\n\\u003cp\\u003eDeprecated, + project is automatically loaded from the JSON file. For GCE only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"email\",\"full_name\":\"compute_resource[email]\",\"description\":\"\\n\\u003cp\\u003eDeprecated, + email is automatically loaded from the JSON file. For GCE only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource\",\"full_name\":\"compute_resource\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"compute_resource[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provider\",\"full_name\":\"compute_resource[provider]\",\"description\":\"\\n\\u003cp\\u003eProviders + include Libvirt, Ovirt, EC2, Vmware, Openstack, AzureRm, GCE\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"compute_resource[url]\",\"description\":\"\\n\\u003cp\\u003eURL + for Libvirt, RHEV and RHEL OpenStack Platform\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"compute_resource[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user\",\"full_name\":\"compute_resource[user]\",\"description\":\"\\n\\u003cp\\u003eUsername + for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key for EC2.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"compute_resource[password]\",\"description\":\"\\n\\u003cp\\u003ePassword + for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"datacenter\",\"full_name\":\"compute_resource[datacenter]\",\"description\":\"\\n\\u003cp\\u003efor + RHEV, VMware Datacenter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ovirt_quota\",\"full_name\":\"compute_resource[ovirt_quota]\",\"description\":\"\\n\\u003cp\\u003efor + RHEV only, ID or Name of quota to use\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"public_key\",\"full_name\":\"compute_resource[public_key]\",\"description\":\"\\n\\u003cp\\u003efor + RHEV only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"region\",\"full_name\":\"compute_resource[region]\",\"description\":\"\\n\\u003cp\\u003efor + AzureRm eg. \\u0026#39;eastus\\u0026#39; and for EC2 only. Use \\u0026#39;us-gov-west-1\\u0026#39; + for EC2 GovCloud region\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tenant\",\"full_name\":\"compute_resource[tenant]\",\"description\":\"\\n\\u003cp\\u003efor + RHEL OpenStack Platform and AzureRm only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain\",\"full_name\":\"compute_resource[domain]\",\"description\":\"\\n\\u003cp\\u003efor + RHEL OpenStack Platform (v3) only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"project_domain_name\",\"full_name\":\"compute_resource[project_domain_name]\",\"description\":\"\\n\\u003cp\\u003efor + RHEL OpenStack Platform (v3) only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"project_domain_id\",\"full_name\":\"compute_resource[project_domain_id]\",\"description\":\"\\n\\u003cp\\u003efor + RHEL OpenStack Platform (v3) only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"server\",\"full_name\":\"compute_resource[server]\",\"description\":\"\\n\\u003cp\\u003efor + VMware\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"set_console_password\",\"full_name\":\"compute_resource[set_console_password]\",\"description\":\"\\n\\u003cp\\u003efor + Libvirt and VMware only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"display_type\",\"full_name\":\"compute_resource[display_type]\",\"description\":\"\\n\\u003cp\\u003efor + Libvirt and RHEV only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eVNC\\u003c/code\\u003e, \\u003ccode\\u003eSPICE\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"keyboard_layout\",\"full_name\":\"compute_resource[keyboard_layout]\",\"description\":\"\\n\\u003cp\\u003efor + RHEV only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ear\\u003c/code\\u003e, \\u003ccode\\u003ede-ch\\u003c/code\\u003e, + \\u003ccode\\u003ees\\u003c/code\\u003e, \\u003ccode\\u003efo\\u003c/code\\u003e, + \\u003ccode\\u003efr-ca\\u003c/code\\u003e, \\u003ccode\\u003ehu\\u003c/code\\u003e, + \\u003ccode\\u003eja\\u003c/code\\u003e, \\u003ccode\\u003emk\\u003c/code\\u003e, + \\u003ccode\\u003eno\\u003c/code\\u003e, \\u003ccode\\u003ept-br\\u003c/code\\u003e, + \\u003ccode\\u003esv\\u003c/code\\u003e, \\u003ccode\\u003eda\\u003c/code\\u003e, + \\u003ccode\\u003een-gb\\u003c/code\\u003e, \\u003ccode\\u003eet\\u003c/code\\u003e, + \\u003ccode\\u003efr\\u003c/code\\u003e, \\u003ccode\\u003efr-ch\\u003c/code\\u003e, + \\u003ccode\\u003eis\\u003c/code\\u003e, \\u003ccode\\u003elt\\u003c/code\\u003e, + \\u003ccode\\u003enl\\u003c/code\\u003e, \\u003ccode\\u003epl\\u003c/code\\u003e, + \\u003ccode\\u003eru\\u003c/code\\u003e, \\u003ccode\\u003eth\\u003c/code\\u003e, + \\u003ccode\\u003ede\\u003c/code\\u003e, \\u003ccode\\u003een-us\\u003c/code\\u003e, + \\u003ccode\\u003efi\\u003c/code\\u003e, \\u003ccode\\u003efr-be\\u003c/code\\u003e, + \\u003ccode\\u003ehr\\u003c/code\\u003e, \\u003ccode\\u003eit\\u003c/code\\u003e, + \\u003ccode\\u003elv\\u003c/code\\u003e, \\u003ccode\\u003enl-be\\u003c/code\\u003e, + \\u003ccode\\u003ept\\u003c/code\\u003e, \\u003ccode\\u003esl\\u003c/code\\u003e, + \\u003ccode\\u003etr\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"caching_enabled\",\"full_name\":\"compute_resource[caching_enabled]\",\"description\":\"\\n\\u003cp\\u003eenable + caching, for VMware only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"compute_resource[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"compute_resource[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"app_ident\",\"full_name\":\"compute_resource[app_ident]\",\"description\":\"\\n\\u003cp\\u003eClient + ID for AzureRm\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"secret_key\",\"full_name\":\"compute_resource[secret_key]\",\"description\":\"\\n\\u003cp\\u003eClient + Secret for AzureRm\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sub_id\",\"full_name\":\"compute_resource[sub_id]\",\"description\":\"\\n\\u003cp\\u003eSubscription + ID for AzureRm\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cloud\",\"full_name\":\"compute_resource[cloud]\",\"description\":\"\\n\\u003cp\\u003eCloud\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"key_path\",\"full_name\":\"compute_resource[key_path]\",\"description\":\"\\n\\u003cp\\u003eCertificate + path, for GCE only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"zone\",\"full_name\":\"compute_resource[zone]\",\"description\":\"\\n\\u003cp\\u003eZone, + for GCE only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"project\",\"full_name\":\"compute_resource[project]\",\"description\":\"\\n\\u003cp\\u003eDeprecated, + project is automatically loaded from the JSON file. For GCE only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"email\",\"full_name\":\"compute_resource[email]\",\"description\":\"\\n\\u003cp\\u003eDeprecated, + email is automatically loaded from the JSON file. For GCE only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_images\",\"name\":\"available_images\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_images\",\"http_method\":\"GET\",\"short_description\":\"List + available images for a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_clusters\",\"name\":\"available_clusters\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_clusters\",\"http_method\":\"GET\",\"short_description\":\"List + available clusters for a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_flavors\",\"name\":\"available_flavors\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_flavors\",\"http_method\":\"GET\",\"short_description\":\"List + available flavors for a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_folders\",\"name\":\"available_folders\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_folders\",\"http_method\":\"GET\",\"short_description\":\"List + available folders for a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_zones\",\"name\":\"available_zones\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_zones\",\"http_method\":\"GET\",\"short_description\":\"List + available zone for a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_networks\",\"name\":\"available_networks\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_networks\",\"http_method\":\"GET\",\"short_description\":\"List + available networks for a compute resource\",\"deprecated\":null},{\"api_url\":\"/api/compute_resources/:id/available_clusters/:cluster_id/available_networks\",\"http_method\":\"GET\",\"short_description\":\"List + available networks for a compute resource cluster\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cluster_id\",\"full_name\":\"cluster_id\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_vnic_profiles\",\"name\":\"available_vnic_profiles\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_vnic_profiles\",\"http_method\":\"GET\",\"short_description\":\"List + available vnic profiles for a compute resource, for RHEV only\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_resource_pools\",\"name\":\"available_resource_pools\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools\",\"http_method\":\"GET\",\"short_description\":\"List + resource pools for a compute resource cluster\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cluster_id\",\"full_name\":\"cluster_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/storage_domain\",\"name\":\"storage_domain\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/storage_domains/:storage_domain_id\",\"http_method\":\"GET\",\"short_description\":\"List + attributes for a given storage domain\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"storage_domain_id\",\"full_name\":\"storage_domain_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_storage_domains\",\"name\":\"available_storage_domains\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_storage_domains\",\"http_method\":\"GET\",\"short_description\":\"List + storage domains for a compute resource\",\"deprecated\":null},{\"api_url\":\"/api/compute_resources/:id/available_storage_domains/:storage_domain\",\"http_method\":\"GET\",\"short_description\":\"List + attributes for a given storage domain\",\"deprecated\":null},{\"api_url\":\"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains\",\"http_method\":\"GET\",\"short_description\":\"List + storage domains for a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cluster_id\",\"full_name\":\"cluster_id\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"storage_domain\",\"full_name\":\"storage_domain\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/storage_pod\",\"name\":\"storage_pod\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/storage_pods/:storage_pod_id\",\"http_method\":\"GET\",\"short_description\":\"List + attributes for a given storage pod\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"storage_pod_id\",\"full_name\":\"storage_pod_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_storage_pods\",\"name\":\"available_storage_pods\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_storage_pods\",\"http_method\":\"GET\",\"short_description\":\"List + storage pods for a compute resource\",\"deprecated\":null},{\"api_url\":\"/api/compute_resources/:id/available_storage_pods/:storage_pod\",\"http_method\":\"GET\",\"short_description\":\"List + attributes for a given storage pod\",\"deprecated\":null},{\"api_url\":\"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods\",\"http_method\":\"GET\",\"short_description\":\"List + storage pods for a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cluster_id\",\"full_name\":\"cluster_id\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"storage_pod\",\"full_name\":\"storage_pod\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_security_groups\",\"name\":\"available_security_groups\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_security_groups\",\"http_method\":\"GET\",\"short_description\":\"List + available security groups for a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/associate\",\"name\":\"associate\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/associate/:vm_id\",\"http_method\":\"PUT\",\"short_description\":\"Associate + VMs to Hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"vm_id\",\"full_name\":\"vm_id\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/refresh_cache\",\"name\":\"refresh_cache\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/refresh_cache\",\"http_method\":\"PUT\",\"short_description\":\"Refresh + Compute Resource Cache\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/available_virtual_machines\",\"name\":\"available_virtual_machines\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_virtual_machines\",\"http_method\":\"GET\",\"short_description\":\"List + available virtual machines for a compute resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/show_vm\",\"name\":\"show_vm\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_virtual_machines/:vm_id\",\"http_method\":\"GET\",\"short_description\":\"Show + a virtual machine\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"vm_id\",\"full_name\":\"vm_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/power_vm\",\"name\":\"power_vm\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_virtual_machines/:vm_id/power\",\"http_method\":\"PUT\",\"short_description\":\"Power + a Virtual Machine\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"vm_id\",\"full_name\":\"vm_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_resources/destroy_vm\",\"name\":\"destroy_vm\",\"apis\":[{\"api_url\":\"/api/compute_resources/:id/available_virtual_machines/:vm_id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a Virtual Machine\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"vm_id\",\"full_name\":\"vm_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"fact_values\":{\"doc_url\":\"/apidoc/v2/fact_values\",\"id\":\"fact_values\",\"api_url\":\"/api\",\"name\":\"Fact_values\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/fact_values/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/fact_values\",\"http_method\":\"GET\",\"short_description\":\"List + all fact values\",\"deprecated\":null},{\"api_url\":\"/api/hosts/:host_id/facts\",\"http_method\":\"GET\",\"short_description\":\"List + all fact values of a given host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"fact\",\"type\":\"string\"},{\"name\":\"fact_short_name\",\"type\":\"string\"},{\"name\":\"facts\",\"type\":\"string\"},{\"name\":\"host\",\"type\":\"string\"},{\"name\":\"host.hostgroup\",\"type\":\"string\"},{\"name\":\"host_id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"origin\",\"type\":\"string\"},{\"name\":\"reported_at\",\"type\":\"datetime\"},{\"name\":\"short_name\",\"type\":\"string\"},{\"name\":\"type\",\"type\":\"string\"},{\"name\":\"value\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"recurring_logics\":{\"doc_url\":\"/apidoc/v2/recurring_logics\",\"id\":\"recurring_logics\",\"api_url\":\"/api\",\"name\":\"Recurring_logics\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/recurring_logics/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/recurring_logics\",\"http_method\":\"GET\",\"short_description\":\"List + recurring logics\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/recurring_logics/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/recurring_logics/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + recurring logic details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the recurring logic\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/recurring_logics/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/recurring_logics/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + recurring logic\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the recurring logic\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"enabled\",\"description\":\"\\n\\u003cp\\u003eWhether + the recurring logic is enabled or disabled.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/recurring_logics/cancel\",\"name\":\"cancel\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/recurring_logics/:id/cancel\",\"http_method\":\"POST\",\"short_description\":\"Cancel + recurring logic\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the recurring logic\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/recurring_logics/bulk_destroy\",\"name\":\"bulk_destroy\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/recurring_logics/bulk_destroy\",\"http_method\":\"POST\",\"short_description\":\"Delete + recurring logics by search query\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + query\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"foreman_tasks\":{\"doc_url\":\"/apidoc/v2/foreman_tasks\",\"id\":\"foreman_tasks\",\"api_url\":\"/api\",\"name\":\"Foreman_tasks\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/foreman_tasks/summary\",\"name\":\"summary\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/tasks/summary\",\"http_method\":\"GET\",\"short_description\":\"Show + task summary\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreman_tasks/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/tasks/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + task details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eUUID + of the task\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreman_tasks/details\",\"name\":\"details\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/tasks/:id/details\",\"http_method\":\"GET\",\"short_description\":\"Show + task extended details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eUUID + of the task\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreman_tasks/bulk_search\",\"name\":\"bulk_search\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/tasks/bulk_search\",\"http_method\":\"POST\",\"short_description\":\"List + dynflow tasks for uuids\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eFor + every search it returns the list of tasks that satisfty the condition. The + reason for supporting multiple searches is the UI that might be ending needing + periodic updates on task status for various searches at the same time. This + way, it is possible to get all the task statuses with one request.\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"searches\",\"full_name\":\"searches\",\"description\":\"\\n\\u003cp\\u003eList + of uuids to fetch info about\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search_id\",\"full_name\":\"searches[search_id]\",\"description\":\"\\n\\u003cp\\u003eArbitraty + value for client to identify the the request parts with results. It\\u0026#39;s + passed in the results to be able to pair the requests and responses properly.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"searches[type]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003euser\\u003c/code\\u003e, \\u003ccode\\u003eresource\\u003c/code\\u003e, + \\u003ccode\\u003etask\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"task_id\",\"full_name\":\"searches[task_id]\",\"description\":\"\\n\\u003cp\\u003eIn + case :type = \\u0026#39;task\\u0026#39;, find the task by the uuid\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"searches[user_id]\",\"description\":\"\\n\\u003cp\\u003eIn + case :type = \\u0026#39;user\\u0026#39;, find tasks for the user\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"resource_type\",\"full_name\":\"searches[resource_type]\",\"description\":\"\\n\\u003cp\\u003eIn + case :type = \\u0026#39;resource\\u0026#39;, what resource type we\\u0026#39;re + searching the tasks for\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"resource_type\",\"full_name\":\"searches[resource_type]\",\"description\":\"\\n\\u003cp\\u003eIn + case :type = \\u0026#39;resource\\u0026#39;, what resource id we\\u0026#39;re + searching the tasks for\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"action_types\",\"full_name\":\"searches[action_types]\",\"description\":\"\\n\\u003cp\\u003eReturn + just tasks of given action type, e.g. `[\u201CActions::Katello::Repository::Synchronize\u201D]`\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eString\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"active_only\",\"full_name\":\"searches[active_only]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"searches[page]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"searches[per_page]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreman_tasks/bulk_resume\",\"name\":\"bulk_resume\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/tasks/bulk_resume\",\"http_method\":\"POST\",\"short_description\":\"Resume + all paused error tasks\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eResumes + all selected resumable tasks. If neither a search query nor an explicit list + of task IDs is provided, it tries to resume all tasks in paused state with + result error.\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eResume + tasks matching search string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"task_ids\",\"full_name\":\"task_ids\",\"description\":\"\\n\\u003cp\\u003eResume + specific tasks by ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreman_tasks/bulk_cancel\",\"name\":\"bulk_cancel\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/tasks/bulk_cancel\",\"http_method\":\"POST\",\"short_description\":\"Cancel + selected cancellable tasks\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eCancels + all selected cancellable tasks. Requires a search query or an explicit list + of task IDs to be provided.\\u003c/p\\u003e\\n\",\"errors\":[{\"code\":400,\"description\":\"Returned + if neither search nor task_ids parameter is provided.\",\"metadata\":null}],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eCancel + tasks matching search string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"task_ids\",\"full_name\":\"task_ids\",\"description\":\"\\n\\u003cp\\u003eCancel + specific tasks by ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreman_tasks/bulk_stop\",\"name\":\"bulk_stop\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/tasks/bulk_stop\",\"http_method\":\"POST\",\"short_description\":\"Stop + selected stoppable tasks\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eStops + all selected tasks which are not already stopped. Requires a search query + or an explicit list of task IDs to be provided.\\u003c/p\\u003e\\n\",\"errors\":[{\"code\":400,\"description\":\"Returned + if neither search nor task_ids parameter is provided.\",\"metadata\":null}],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eStop + tasks matching search string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"task_ids\",\"full_name\":\"task_ids\",\"description\":\"\\n\\u003cp\\u003eStop + specific tasks by ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreman_tasks/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/tasks\",\"http_method\":\"GET\",\"short_description\":\"List + tasks\",\"deprecated\":null},{\"api_url\":\"/foreman_tasks/api/tasks/:parent_task_id/sub_tasks\",\"http_method\":\"GET\",\"short_description\":\"Show + sub_tasks details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parent_task_id\",\"full_name\":\"parent_task_id\",\"description\":\"\\n\\u003cp\\u003eUUID + of the task\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreman_tasks/callback\",\"name\":\"callback\",\"apis\":[{\"api_url\":\"/foreman_tasks/api/tasks/callback\",\"http_method\":\"POST\",\"short_description\":\"Send + data to the task from external executor (such as smart_proxy_dynflow)\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"callback\",\"full_name\":\"callback\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"task_id\",\"full_name\":\"callback[task_id]\",\"description\":\"\\n\\u003cp\\u003eUUID + of the task\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"step_id\",\"full_name\":\"callback[step_id]\",\"description\":\"\\n\\u003cp\\u003eThe + ID of the step inside the execution plan to send the event to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"data\",\"full_name\":\"data\",\"description\":\"\\n\\u003cp\\u003eData + to be sent to the action\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"callbacks\",\"full_name\":\"callbacks\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"callback\",\"full_name\":\"callbacks[callback]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"task_id\",\"full_name\":\"callbacks[callback][task_id]\",\"description\":\"\\n\\u003cp\\u003eUUID + of the task\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"step_id\",\"full_name\":\"callbacks[callback][step_id]\",\"description\":\"\\n\\u003cp\\u003eThe + ID of the step inside the execution plan to send the event to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"data\",\"full_name\":\"callbacks[data]\",\"description\":\"\\n\\u003cp\\u003eData + to be sent to the action\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"foreign_input_sets\":{\"doc_url\":\"/apidoc/v2/foreign_input_sets\",\"id\":\"foreign_input_sets\",\"api_url\":\"/api\",\"name\":\"Foreign_input_sets\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/foreign_input_sets/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/templates/:template_id/foreign_input_sets\",\"http_method\":\"GET\",\"short_description\":\"List + foreign input sets\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"template_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreign_input_sets/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/templates/:template_id/foreign_input_sets/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + foreign input set details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"template_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreign_input_sets/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/templates/:template_id/foreign_input_sets\",\"http_method\":\"POST\",\"short_description\":\"Create + a foreign input set\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"template_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"foreign_input_set\",\"full_name\":\"foreign_input_set\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"target_template_id\",\"full_name\":\"foreign_input_set[target_template_id]\",\"description\":\"\\n\\u003cp\\u003eTarget + template ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_all\",\"full_name\":\"foreign_input_set[include_all]\",\"description\":\"\\n\\u003cp\\u003eInclude + all inputs from the foreign template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include\",\"full_name\":\"foreign_input_set[include]\",\"description\":\"\\n\\u003cp\\u003eA + comma separated list of input names to be included from the foreign template.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"exclude\",\"full_name\":\"foreign_input_set[exclude]\",\"description\":\"\\n\\u003cp\\u003eA + comma separated list of input names to be included from the foreign template.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"foreign_input_set[description]\",\"description\":\"\\n\\u003cp\\u003eInput + set description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreign_input_sets/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/templates/:template_id/foreign_input_sets/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a foreign input set\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"template_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/foreign_input_sets/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/templates/:template_id/foreign_input_sets/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a foreign input set\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"template_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"foreign_input_set\",\"full_name\":\"foreign_input_set\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"target_template_id\",\"full_name\":\"foreign_input_set[target_template_id]\",\"description\":\"\\n\\u003cp\\u003eTarget + template ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_all\",\"full_name\":\"foreign_input_set[include_all]\",\"description\":\"\\n\\u003cp\\u003eInclude + all inputs from the foreign template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include\",\"full_name\":\"foreign_input_set[include]\",\"description\":\"\\n\\u003cp\\u003eA + comma separated list of input names to be included from the foreign template.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"exclude\",\"full_name\":\"foreign_input_set[exclude]\",\"description\":\"\\n\\u003cp\\u003eA + comma separated list of input names to be included from the foreign template.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"foreign_input_set[description]\",\"description\":\"\\n\\u003cp\\u003eInput + set description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"job_invocations\":{\"doc_url\":\"/apidoc/v2/job_invocations\",\"id\":\"job_invocations\",\"api_url\":\"/api\",\"name\":\"Job_invocations\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/job_invocations/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/job_invocations\",\"http_method\":\"GET\",\"short_description\":\"List + job invocations\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_invocations/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/job_invocations/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + job invocation\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_status\",\"full_name\":\"host_status\",\"description\":\"\\n\\u003cp\\u003eShow + Job status for the hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_invocations/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/job_invocations\",\"http_method\":\"POST\",\"short_description\":\"Create + a job invocation\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"job_invocation\",\"full_name\":\"job_invocation\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"job_template_id\",\"full_name\":\"job_invocation[job_template_id]\",\"description\":\"\\n\\u003cp\\u003eThe + job template to use, parameter is required unless feature was specified\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"targeting_type\",\"full_name\":\"job_invocation[targeting_type]\",\"description\":\"\\n\\u003cp\\u003eInvocation + type, one of {\u201Cstatic_query\u201D=\\u0026gt;\u201CStatic Query\u201D, + \u201Cdynamic_query\u201D=\\u0026gt;\u201CDynamic Query\u201D}\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"randomized_ordering\",\"full_name\":\"job_invocation[randomized_ordering]\",\"description\":\"\\n\\u003cp\\u003eExecute + the jobs on hosts in randomized order\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"inputs\",\"full_name\":\"job_invocation[inputs]\",\"description\":\"\\n\\u003cp\\u003eInputs + to use\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssh\",\"full_name\":\"job_invocation[ssh]\",\"description\":\"\\n\\u003cp\\u003eSSH + provider specific options\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"effective_user\",\"full_name\":\"job_invocation[ssh][effective_user]\",\"description\":\"\\n\\u003cp\\u003eWhat + user should be used to run the script (using sudo-like mechanisms). Defaults + to a template parameter or global setting.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"effective_user_password\",\"full_name\":\"job_invocation[ssh][effective_user_password]\",\"description\":\"\\n\\u003cp\\u003eSet + password for effective user (using sudo-like mechanisms)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"ssh_user\",\"full_name\":\"job_invocation[ssh_user]\",\"description\":\"\\n\\u003cp\\u003eSet + SSH user\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"job_invocation[password]\",\"description\":\"\\n\\u003cp\\u003eSet + SSH password\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"key_passphrase\",\"full_name\":\"job_invocation[key_passphrase]\",\"description\":\"\\n\\u003cp\\u003eSet + SSH key passphrase\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"recurrence\",\"full_name\":\"job_invocation[recurrence]\",\"description\":\"\\n\\u003cp\\u003eCreate + a recurring job\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"cron_line\",\"full_name\":\"job_invocation[recurrence][cron_line]\",\"description\":\"\\n\\u003cp\\u003eHow + often the job should occur, in the cron format\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"max_iteration\",\"full_name\":\"job_invocation[recurrence][max_iteration]\",\"description\":\"\\n\\u003cp\\u003eRepeat + a maximum of N times\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"end_time\",\"full_name\":\"job_invocation[recurrence][end_time]\",\"description\":\"\\n\\u003cp\\u003ePerform + no more executions after this time\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"DateTime\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose\",\"full_name\":\"job_invocation[recurrence][purpose]\",\"description\":\"\\n\\u003cp\\u003eDesignation + of a special purpose\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"scheduling\",\"full_name\":\"job_invocation[scheduling]\",\"description\":\"\\n\\u003cp\\u003eSchedule + the job to start at a later time\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"start_at\",\"full_name\":\"job_invocation[scheduling][start_at]\",\"description\":\"\\n\\u003cp\\u003eSchedule + the job for a future time\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"DateTime\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"start_before\",\"full_name\":\"job_invocation[scheduling][start_before]\",\"description\":\"\\n\\u003cp\\u003eIndicates + that the action should be cancelled if it cannot be started before this time.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"DateTime\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"concurrency_control\",\"full_name\":\"job_invocation[concurrency_control]\",\"description\":\"\\n\\u003cp\\u003eControl + concurrency level and distribution over time\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"concurrency_level\",\"full_name\":\"job_invocation[concurrency_control][concurrency_level]\",\"description\":\"\\n\\u003cp\\u003eRun + at most N tasks at a time\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"bookmark_id\",\"full_name\":\"job_invocation[bookmark_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search_query\",\"full_name\":\"job_invocation[search_query]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description_format\",\"full_name\":\"job_invocation[description_format]\",\"description\":\"\\n\\u003cp\\u003eOverride + the description format from the template for this invocation only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"execution_timeout_interval\",\"full_name\":\"job_invocation[execution_timeout_interval]\",\"description\":\"\\n\\u003cp\\u003eOverride + the timeout interval from the template for this invocation only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"feature\",\"full_name\":\"job_invocation[feature]\",\"description\":\"\\n\\u003cp\\u003eRemote + execution feature label that should be triggered, job template assigned to + this feature will be used\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"time_to_pickup\",\"full_name\":\"job_invocation[time_to_pickup]\",\"description\":\"\\n\\u003cp\\u003eOverride + the global time to pickup interval for this invocation only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible\",\"full_name\":\"job_invocation[ansible]\",\"description\":\"\\n\\u003cp\\u003eAnsible + provider specific inputs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"tags\",\"full_name\":\"job_invocation[ansible][tags]\",\"description\":\"\\n\\u003cp\\u003eA + comma separated list of tags to use for Ansible run\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tags_flag\",\"full_name\":\"job_invocation[ansible][tags_flag]\",\"description\":\"\\n\\u003cp\\u003eIncludeExclude + tags for Ansible run\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003einclude\\u003c/code\\u003e, \\u003ccode\\u003eexclude\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_invocations/output\",\"name\":\"output\",\"apis\":[{\"api_url\":\"/api/job_invocations/:id/hosts/:host_id\",\"http_method\":\"GET\",\"short_description\":\"Get + output for a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"since\",\"full_name\":\"since\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_invocations/raw_output\",\"name\":\"raw_output\",\"apis\":[{\"api_url\":\"/api/job_invocations/:id/hosts/:host_id/raw\",\"http_method\":\"GET\",\"short_description\":\"Get + raw output for a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_invocations/cancel\",\"name\":\"cancel\",\"apis\":[{\"api_url\":\"/api/job_invocations/:id/cancel\",\"http_method\":\"POST\",\"short_description\":\"Cancel + job invocation\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"force\",\"full_name\":\"force\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_invocations/rerun\",\"name\":\"rerun\",\"apis\":[{\"api_url\":\"/api/job_invocations/:id/rerun\",\"http_method\":\"POST\",\"short_description\":\"Rerun + job on failed hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"failed_only\",\"full_name\":\"failed_only\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/job_invocations/outputs\",\"name\":\"outputs\",\"apis\":[{\"api_url\":\"/api/job_invocations/:id/outputs\",\"http_method\":\"GET\",\"short_description\":\"Get + outputs of hosts in a job\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search_query\",\"full_name\":\"search_query\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"since\",\"full_name\":\"since\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"raw\",\"full_name\":\"raw\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"remote_execution_features\":{\"doc_url\":\"/apidoc/v2/remote_execution_features\",\"id\":\"remote_execution_features\",\"api_url\":\"/api\",\"name\":\"Remote_execution_features\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/remote_execution_features/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/remote_execution_features\",\"http_method\":\"GET\",\"short_description\":\"List + remote execution features\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/remote_execution_features/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/remote_execution_features/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + remote execution feature\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/remote_execution_features/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/remote_execution_features/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a job template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"remote_execution_feature\",\"full_name\":\"remote_execution_feature\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"job_template_id\",\"full_name\":\"remote_execution_feature[job_template_id]\",\"description\":\"\\n\\u003cp\\u003eJob + template ID to be used for the feature\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/remote_execution_features/available_remote_execution_features\",\"name\":\"available_remote_execution_features\",\"apis\":[{\"api_url\":\"/api/api/hosts/:id/available_remote_execution_features\",\"http_method\":\"GET\",\"short_description\":\"List + available remote execution features for a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"template_invocations\":{\"doc_url\":\"/apidoc/v2/template_invocations\",\"id\":\"template_invocations\",\"api_url\":\"/api\",\"name\":\"Template_invocations\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/template_invocations/template_invocations\",\"name\":\"template_invocations\",\"apis\":[{\"api_url\":\"/api/job_invocations/:job_invocation_id/template_invocations\",\"http_method\":\"GET\",\"short_description\":\"List + template invocations belonging to job invocation\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"job_invocation_id\",\"full_name\":\"job_invocation_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"ansible_inventories\":{\"doc_url\":\"/apidoc/v2/ansible_inventories\",\"id\":\"ansible_inventories\",\"api_url\":\"/api\",\"name\":\"Ansible_inventories\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/ansible_inventories/hosts\",\"name\":\"hosts\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_inventories/hosts\",\"http_method\":\"POST\",\"short_description\":\"Show + Ansible inventory for hosts\",\"deprecated\":null},{\"api_url\":\"/ansible/api/ansible_inventories/hosts\",\"http_method\":\"GET\",\"short_description\":\"Show + Ansible inventory for hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"host_ids\",\"description\":\"\\n\\u003cp\\u003eIDs + of hosts included in inventory\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_inventories/hostgroups\",\"name\":\"hostgroups\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_inventories/hostgroups\",\"http_method\":\"POST\",\"short_description\":\"Show + Ansible inventory for hostgroups\",\"deprecated\":null},{\"api_url\":\"/ansible/api/ansible_inventories/hostgroups\",\"http_method\":\"GET\",\"short_description\":\"Show + Ansible inventory for hostgroups\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_ids\",\"full_name\":\"hostgroup_ids\",\"description\":\"\\n\\u003cp\\u003eIDs + of hostgroups included in inventory\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_inventories/schedule\",\"name\":\"schedule\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_inventories/schedule\",\"http_method\":\"POST\",\"short_description\":\"Schedule + generating of Ansible Inventory report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"input_values\",\"full_name\":\"input_values\",\"description\":\"\\n\\u003cp\\u003eHash + of input values of type input=\\u0026gt;value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"report_format\",\"full_name\":\"report_format\",\"description\":\"\\n\\u003cp\\u003eReport + format, defaults to \\u0026#39;json\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ecsv\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ehtml\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[\"POST + /ansible/api/ansible_inventories/schedule\\n{\\n \\\"input_values\\\": {\\n + \ \\\"Organization\\\": \\\"yes\\\",\\n \\\"Location\\\": \\\"yes\\\",\\n + \ \\\"IPv4\\\": \\\"yes\\\",\\n \\\"Facts\\\": \\\"no\\\"\\n }\\n}\\n200\\n{\\n + \ \\\"job_id\\\": UNIQUE-REPORT-GENERATING-JOB-UUID\\n \\\"data_url\\\": + \\\"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\\\"\\n}\\n\"],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"ansible_override_values\":{\"doc_url\":\"/apidoc/v2/ansible_override_values\",\"id\":\"ansible_override_values\",\"api_url\":\"/api\",\"name\":\"Ansible_override_values\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/ansible_override_values/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_override_values\",\"http_method\":\"POST\",\"short_description\":\"Create + an override value for a specific ansible variable\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_variable_id\",\"full_name\":\"ansible_variable_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"override_value\",\"full_name\":\"override_value\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"match\",\"full_name\":\"override_value[match]\",\"description\":\"\\n\\u003cp\\u003eOverride + match\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"override_value[value]\",\"description\":\"\\n\\u003cp\\u003eOverride + value, required if omit is false\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of types: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e\",\"expected_type\":\"any_type\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_override_values/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_override_values/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Destroy + an override value\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"ansible_playbooks\":{\"doc_url\":\"/apidoc/v2/ansible_playbooks\",\"id\":\"ansible_playbooks\",\"api_url\":\"/api\",\"name\":\"Ansible_playbooks\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/ansible_playbooks/sync\",\"name\":\"sync\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_playbooks/sync\",\"http_method\":\"PUT\",\"short_description\":\"Sync + Ansible playbooks\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"proxy_id\",\"full_name\":\"proxy_id\",\"description\":\"\\n\\u003cp\\u003eCapsule + to sync from\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"playbooks_names\",\"full_name\":\"playbooks_names\",\"description\":\"\\n\\u003cp\\u003eAnsible + \ playbooks names to be synced\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_playbooks/fetch\",\"name\":\"fetch\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_playbooks/fetch\",\"http_method\":\"GET\",\"short_description\":\"Fetch + Ansible playbooks available to be synced\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"proxy_id\",\"full_name\":\"proxy_id\",\"description\":\"\\n\\u003cp\\u003eCapsule + to fetch from\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"ansible_roles\":{\"doc_url\":\"/apidoc/v2/ansible_roles\",\"id\":\"ansible_roles\",\"api_url\":\"/api\",\"name\":\"Ansible_roles\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/ansible_roles/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_roles/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + role\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_roles/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_roles\",\"http_method\":\"GET\",\"short_description\":\"List + Ansible roles\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"host\",\"type\":\"string\"},{\"name\":\"host_id\",\"type\":\"integer\"},{\"name\":\"hostgroup\",\"type\":\"string\"},{\"name\":\"hostgroup_id\",\"type\":\"integer\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"updated_at\",\"type\":\"datetime\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_roles/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_roles/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Deletes + Ansible role\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_roles/import\",\"name\":\"import\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_roles/import\",\"http_method\":\"PUT\",\"short_description\":\"DEPRECATED: + Import Ansible roles\",\"deprecated\":true}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"proxy_id\",\"full_name\":\"proxy_id\",\"description\":\"\\n\\u003cp\\u003eCapsule + to import from\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"role_names\",\"full_name\":\"role_names\",\"description\":\"\\n\\u003cp\\u003eAnsible + role names to be imported\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_roles/sync\",\"name\":\"sync\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_roles/sync\",\"http_method\":\"PUT\",\"short_description\":\"Sync + Ansible roles\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"proxy_id\",\"full_name\":\"proxy_id\",\"description\":\"\\n\\u003cp\\u003eCapsule + to sync from\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"role_names\",\"full_name\":\"role_names\",\"description\":\"\\n\\u003cp\\u003eAnsible + role names to be synced\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_roles/obsolete\",\"name\":\"obsolete\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_roles/obsolete\",\"http_method\":\"PUT\",\"short_description\":\"DEPRECATED: + Obsolete Ansible roles\",\"deprecated\":true}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"proxy_id\",\"full_name\":\"proxy_id\",\"description\":\"\\n\\u003cp\\u003eCapsule + to import from\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_roles/fetch\",\"name\":\"fetch\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_roles/fetch\",\"http_method\":\"GET\",\"short_description\":\"Fetch + Ansible roles available to be synced\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"proxy_id\",\"full_name\":\"proxy_id\",\"description\":\"\\n\\u003cp\\u003eCapsule + to fetch from\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"ansible_variables\":{\"doc_url\":\"/apidoc/v2/ansible_variables\",\"id\":\"ansible_variables\",\"api_url\":\"/api\",\"name\":\"Ansible_variables\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/ansible_variables/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_variables/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + variable\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_variables/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_variables\",\"http_method\":\"GET\",\"short_description\":\"List + Ansible variables\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"ansible_role\",\"type\":\"string\"},{\"name\":\"avoid_duplicates\",\"values\":[\"true\",\"false\"]},{\"name\":\"imported\",\"values\":[\"true\",\"false\"]},{\"name\":\"key\",\"type\":\"string\"},{\"name\":\"merge_default\",\"values\":[\"true\",\"false\"]},{\"name\":\"merge_overrides\",\"values\":[\"true\",\"false\"]},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"override\",\"values\":[\"true\",\"false\"]},{\"name\":\"parameter\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_variables/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_variables/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Deletes + Ansible variable\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_variables/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_variables\",\"http_method\":\"POST\",\"short_description\":\"Create + Ansible variable\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_variable\",\"full_name\":\"ansible_variable\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"variable\",\"full_name\":\"ansible_variable[variable]\",\"description\":\"\\n\\u003cp\\u003eName + of variable\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_role_id\",\"full_name\":\"ansible_variable[ansible_role_id]\",\"description\":\"\\n\\u003cp\\u003eRole + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default_value\",\"full_name\":\"ansible_variable[default_value]\",\"description\":\"\\n\\u003cp\\u003eDefault + value of variable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of types: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e\",\"expected_type\":\"any_type\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"ansible_variable[hidden_value]\",\"description\":\"\\n\\u003cp\\u003eWhen + enabled the parameter is hidden in the UI\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"override_value_order\",\"full_name\":\"ansible_variable[override_value_order]\",\"description\":\"\\n\\u003cp\\u003eThe + order in which values are resolved\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"ansible_variable[description]\",\"description\":\"\\n\\u003cp\\u003eDescription + of variable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"validator_type\",\"full_name\":\"ansible_variable[validator_type]\",\"description\":\"\\n\\u003cp\\u003eTypes + of validation values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eregexp\\u003c/code\\u003e, \\u003ccode\\u003elist\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"validator_rule\",\"full_name\":\"ansible_variable[validator_rule]\",\"description\":\"\\n\\u003cp\\u003eUsed + to enforce certain values for the parameter values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"variable_type\",\"full_name\":\"ansible_variable[variable_type]\",\"description\":\"\\n\\u003cp\\u003eTypes + of variable values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"merge_overrides\",\"full_name\":\"ansible_variable[merge_overrides]\",\"description\":\"\\n\\u003cp\\u003eMerge + all matching values (only array/hash type)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"merge_default\",\"full_name\":\"ansible_variable[merge_default]\",\"description\":\"\\n\\u003cp\\u003eInclude + default value when merging all matching values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"avoid_duplicates\",\"full_name\":\"ansible_variable[avoid_duplicates]\",\"description\":\"\\n\\u003cp\\u003eRemove + duplicate values (only array type)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"override\",\"full_name\":\"ansible_variable[override]\",\"description\":\"\\n\\u003cp\\u003eWhether + to override variable or not\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_variables/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_variables/:id\",\"http_method\":\"PUT\",\"short_description\":\"Updates + Ansible variable\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_variable\",\"full_name\":\"ansible_variable\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"variable\",\"full_name\":\"ansible_variable[variable]\",\"description\":\"\\n\\u003cp\\u003eName + of variable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_role_id\",\"full_name\":\"ansible_variable[ansible_role_id]\",\"description\":\"\\n\\u003cp\\u003eRole + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default_value\",\"full_name\":\"ansible_variable[default_value]\",\"description\":\"\\n\\u003cp\\u003eDefault + value of variable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of types: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e\",\"expected_type\":\"any_type\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"ansible_variable[hidden_value]\",\"description\":\"\\n\\u003cp\\u003eWhen + enabled the parameter is hidden in the UI\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"override_value_order\",\"full_name\":\"ansible_variable[override_value_order]\",\"description\":\"\\n\\u003cp\\u003eThe + order in which values are resolved\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"ansible_variable[description]\",\"description\":\"\\n\\u003cp\\u003eDescription + of variable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"validator_type\",\"full_name\":\"ansible_variable[validator_type]\",\"description\":\"\\n\\u003cp\\u003eTypes + of validation values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eregexp\\u003c/code\\u003e, \\u003ccode\\u003elist\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"validator_rule\",\"full_name\":\"ansible_variable[validator_rule]\",\"description\":\"\\n\\u003cp\\u003eUsed + to enforce certain values for the parameter values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"variable_type\",\"full_name\":\"ansible_variable[variable_type]\",\"description\":\"\\n\\u003cp\\u003eTypes + of variable values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"merge_overrides\",\"full_name\":\"ansible_variable[merge_overrides]\",\"description\":\"\\n\\u003cp\\u003eMerge + all matching values (only array/hash type)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"merge_default\",\"full_name\":\"ansible_variable[merge_default]\",\"description\":\"\\n\\u003cp\\u003eInclude + default value when merging all matching values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"avoid_duplicates\",\"full_name\":\"ansible_variable[avoid_duplicates]\",\"description\":\"\\n\\u003cp\\u003eRemove + duplicate values (only array type)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"override\",\"full_name\":\"ansible_variable[override]\",\"description\":\"\\n\\u003cp\\u003eWhether + to override variable or not\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_variables/import\",\"name\":\"import\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_variables/import\",\"http_method\":\"PUT\",\"short_description\":\"DEPRECATED: + Import Ansible variables. This will only import variables for already existing + roles, it will not import any new roles\",\"deprecated\":true}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"proxy_id\",\"full_name\":\"proxy_id\",\"description\":\"\\n\\u003cp\\u003eCapsule + to import from\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_variables/obsolete\",\"name\":\"obsolete\",\"apis\":[{\"api_url\":\"/ansible/api/ansible_variables/obsolete\",\"http_method\":\"PUT\",\"short_description\":\"DEPRECATED: + Obsolete Ansible variables. This will only obsolete variables for already + existing roles, it will not delete any old roles\",\"deprecated\":true}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"proxy_id\",\"full_name\":\"proxy_id\",\"description\":\"\\n\\u003cp\\u003eCapsule + to import from\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"candlepin_dynflow_proxy\":{\"doc_url\":\"/apidoc/v2/candlepin_dynflow_proxy\",\"id\":\"candlepin_dynflow_proxy\",\"api_url\":\"/api\",\"name\":\"Candlepin_dynflow_proxy\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/candlepin_dynflow_proxy/upload_profiles\",\"name\":\"upload_profiles\",\"apis\":[{\"api_url\":\"/katello/api/consumers/:id/profiles\",\"http_method\":\"PUT\",\"short_description\":\"Update + installed packages, enabled repos, module inventory\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eUUID + of the consumer\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"candlepin_proxies\":{\"doc_url\":\"/apidoc/v2/candlepin_proxies\",\"id\":\"candlepin_proxies\",\"api_url\":\"/api\",\"name\":\"Candlepin_proxies\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/candlepin_proxies/upload_tracer_profile\",\"name\":\"upload_tracer_profile\",\"apis\":[{\"api_url\":\"/katello/api/consumers/:id/tracer\",\"http_method\":\"PUT\",\"short_description\":\"Update + services requiring restart\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"traces\",\"full_name\":\"traces\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/candlepin_proxies/enabled_repos\",\"name\":\"enabled_repos\",\"apis\":[{\"api_url\":\"/katello/api/systems/:id/enabled_repos\",\"http_method\":\"PUT\",\"short_description\":\"Update + the information about enabled repositories\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eUsed + to keep the information about enabled repositories up to date. This information + is then used for computing the errata available for the system.\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"enabled_repos\",\"full_name\":\"enabled_repos\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"repos\",\"full_name\":\"enabled_repos[repos]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"baseurl\",\"full_name\":\"enabled_repos[repos][baseurl]\",\"description\":\"\\n\\u003cp\\u003eList + of enabled repo urls for the repo (Only first is used.)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}]},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eUUID + of the system\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"activation_keys\":{\"doc_url\":\"/apidoc/v2/activation_keys\",\"id\":\"activation_keys\",\"api_url\":\"/api\",\"name\":\"Activation_keys\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/activation_keys/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys\",\"http_method\":\"GET\",\"short_description\":\"List + activation keys\",\"deprecated\":null},{\"api_url\":\"/katello/api/environments/:environment_id/activation_keys\",\"http_method\":\"GET\",\"short_description\":null,\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/activation_keys\",\"http_method\":\"GET\",\"short_description\":null,\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eactivation + key name to filter by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"addon\",\"type\":\"string\"},{\"name\":\"content_view\",\"type\":\"string\"},{\"name\":\"content_view_id\",\"type\":\"integer\"},{\"name\":\"description\",\"type\":\"text\"},{\"name\":\"environment\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"role\",\"type\":\"string\"},{\"name\":\"subscription_id\",\"type\":\"string\"},{\"name\":\"subscription_name\",\"type\":\"string\"},{\"name\":\"usage\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys\",\"http_method\":\"POST\",\"short_description\":\"Create + an activation key\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003ename\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003edescription\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment\",\"full_name\":\"environment\",\"description\":\"\\n\\u003cp\\u003eenvironment\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + id\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view id\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"max_hosts\",\"full_name\":\"max_hosts\",\"description\":\"\\n\\u003cp\\u003emaximum + number of registered content hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"unlimited_hosts\",\"full_name\":\"unlimited_hosts\",\"description\":\"\\n\\u003cp\\u003ecan + the activation key have unlimited hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"release_version\",\"full_name\":\"release_version\",\"description\":\"\\n\\u003cp\\u003econtent + release version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"service_level\",\"full_name\":\"service_level\",\"description\":\"\\n\\u003cp\\u003eservice + level\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"auto_attach\",\"full_name\":\"auto_attach\",\"description\":\"\\n\\u003cp\\u003eauto + attach subscriptions upon registration\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_usage\",\"full_name\":\"purpose_usage\",\"description\":\"\\n\\u003cp\\u003eSets + the system purpose usage\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_role\",\"full_name\":\"purpose_role\",\"description\":\"\\n\\u003cp\\u003eSets + the system purpose usage\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_addons\",\"full_name\":\"purpose_addons\",\"description\":\"\\n\\u003cp\\u003eSets + the system add-ons\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an activation key\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003ename\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003edescription\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + id\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view id\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"max_hosts\",\"full_name\":\"max_hosts\",\"description\":\"\\n\\u003cp\\u003emaximum + number of registered content hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"unlimited_hosts\",\"full_name\":\"unlimited_hosts\",\"description\":\"\\n\\u003cp\\u003ecan + the activation key have unlimited hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"release_version\",\"full_name\":\"release_version\",\"description\":\"\\n\\u003cp\\u003econtent + release version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"service_level\",\"full_name\":\"service_level\",\"description\":\"\\n\\u003cp\\u003eservice + level\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"auto_attach\",\"full_name\":\"auto_attach\",\"description\":\"\\n\\u003cp\\u003eauto + attach subscriptions upon registration\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_usage\",\"full_name\":\"purpose_usage\",\"description\":\"\\n\\u003cp\\u003eSets + the system purpose usage\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_role\",\"full_name\":\"purpose_role\",\"description\":\"\\n\\u003cp\\u003eSets + the system purpose usage\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"purpose_addons\",\"full_name\":\"purpose_addons\",\"description\":\"\\n\\u003cp\\u003eSets + the system add-ons\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Destroy + an activation key\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an activation key\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"show_hosts\",\"full_name\":\"show_hosts\",\"description\":\"\\n\\u003cp\\u003eShow + hosts associated to an activation key\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/copy\",\"name\":\"copy\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id/copy\",\"http_method\":\"POST\",\"short_description\":\"Copy + an activation key\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"new_name\",\"full_name\":\"new_name\",\"description\":\"\\n\\u003cp\\u003eName + of new activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/available_host_collections\",\"name\":\"available_host_collections\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id/host_collections/available\",\"http_method\":\"GET\",\"short_description\":\"List + host collections the activation key does not belong to\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003ehost + collection name to filter by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/available_releases\",\"name\":\"available_releases\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id/releases\",\"http_method\":\"GET\",\"short_description\":\"Show + release versions available for an activation key\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/add_host_collections\",\"name\":\"add_host_collections\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id/host_collections\",\"http_method\":\"POST\",\"short_description\":null,\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_collection_ids\",\"full_name\":\"host_collection_ids\",\"description\":\"\\n\\u003cp\\u003eList + of host collection IDs to associate with activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/remove_host_collections\",\"name\":\"remove_host_collections\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id/host_collections\",\"http_method\":\"PUT\",\"short_description\":null,\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_collection_ids\",\"full_name\":\"host_collection_ids\",\"description\":\"\\n\\u003cp\\u003eList + of host collection IDs to disassociate from the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/add_subscriptions\",\"name\":\"add_subscriptions\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id/add_subscriptions\",\"http_method\":\"PUT\",\"short_description\":\"Attach + a subscription\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subscription_id\",\"full_name\":\"subscription_id\",\"description\":\"\\n\\u003cp\\u003eSubscription + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"quantity\",\"full_name\":\"quantity\",\"description\":\"\\n\\u003cp\\u003eQuantity + of this subscription to add\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subscriptions\",\"full_name\":\"subscriptions\",\"description\":\"\\n\\u003cp\\u003eArray + of subscriptions to add\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"id\",\"full_name\":\"subscriptions[id]\",\"description\":\"\\n\\u003cp\\u003eSubscription + Pool uuid\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"quantity\",\"full_name\":\"subscriptions[quantity]\",\"description\":\"\\n\\u003cp\\u003eQuantity + of this subscriptions to add\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/remove_subscriptions\",\"name\":\"remove_subscriptions\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id/remove_subscriptions\",\"http_method\":\"PUT\",\"short_description\":\"Unattach + a subscription\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subscription_id\",\"full_name\":\"subscription_id\",\"description\":\"\\n\\u003cp\\u003eSubscription + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subscriptions\",\"full_name\":\"subscriptions\",\"description\":\"\\n\\u003cp\\u003eArray + of subscriptions to add\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"id\",\"full_name\":\"subscriptions[id]\",\"description\":\"\\n\\u003cp\\u003eSubscription + Pool uuid\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/content_override\",\"name\":\"content_override\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id/content_override\",\"http_method\":\"PUT\",\"short_description\":\"Override + content for activation_key\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_overrides\",\"full_name\":\"content_overrides\",\"description\":\"\\n\\u003cp\\u003eArray + of Content override parameters to be added in bulk\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"content_label\",\"full_name\":\"content_overrides[content_label]\",\"description\":\"\\n\\u003cp\\u003eLabel + of the content\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"content_overrides[value]\",\"description\":\"\\n\\u003cp\\u003eOverride + value. Provide a boolean value if name is \\u0026#39;enabled\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"content_overrides[name]\",\"description\":\"\\n\\u003cp\\u003eOverride + parameter key or name. Note if name is not provided the default name will + be \\u0026#39;enabled\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"remove\",\"full_name\":\"content_overrides[remove]\",\"description\":\"\\n\\u003cp\\u003eSet + true to remove an override and reset it to \\u0026#39;default\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/activation_keys/product_content\",\"name\":\"product_content\",\"apis\":[{\"api_url\":\"/katello/api/activation_keys/:id/product_content\",\"http_method\":\"GET\",\"short_description\":\"Show + content available for an activation key\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the activation key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_access_mode_all\",\"full_name\":\"content_access_mode_all\",\"description\":\"\\n\\u003cp\\u003eGet + all content available, not just that provided by subscriptions\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_access_mode_env\",\"full_name\":\"content_access_mode_env\",\"description\":\"\\n\\u003cp\\u003eLimit + content to just that available in the activation key\\u0026#39;s content view + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"alternate_content_sources_bulk_actions\":{\"doc_url\":\"/apidoc/v2/alternate_content_sources_bulk_actions\",\"id\":\"alternate_content_sources_bulk_actions\",\"api_url\":\"/api\",\"name\":\"Alternate_content_sources_bulk_actions\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/alternate_content_sources_bulk_actions/destroy_alternate_content_sources\",\"name\":\"destroy_alternate_content_sources\",\"apis\":[{\"api_url\":\"/katello/api/alternate_content_sources/bulk/destroy\",\"http_method\":\"PUT\",\"short_description\":\"Destroy + one or more alternate content sources\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eList + of alternate content source IDs\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/alternate_content_sources_bulk_actions/refresh_alternate_content_sources\",\"name\":\"refresh_alternate_content_sources\",\"apis\":[{\"api_url\":\"/katello/api/alternate_content_sources/bulk/refresh\",\"http_method\":\"POST\",\"short_description\":\"Refresh + alternate content sources\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eList + of alternate content source IDs\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/alternate_content_sources_bulk_actions/refresh_all_alternate_content_sources\",\"name\":\"refresh_all_alternate_content_sources\",\"apis\":[{\"api_url\":\"/katello/api/alternate_content_sources/bulk/refresh_all\",\"http_method\":\"POST\",\"short_description\":\"Refresh + all alternate content sources\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"alternate_content_sources\":{\"doc_url\":\"/apidoc/v2/alternate_content_sources\",\"id\":\"alternate_content_sources\",\"api_url\":\"/api\",\"name\":\"Alternate_content_sources\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/alternate_content_sources/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/alternate_content_sources\",\"http_method\":\"GET\",\"short_description\":\"List + alternate content sources.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the alternate content source\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"alternate_content_source_type\",\"type\":\"string\"},{\"name\":\"base_url\",\"type\":\"string\"},{\"name\":\"content_type\",\"type\":\"string\"},{\"name\":\"description\",\"type\":\"text\"},{\"name\":\"label\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"product_id\",\"type\":\"integer\"},{\"name\":\"product_name\",\"type\":\"string\"},{\"name\":\"smart_proxy_id\",\"type\":\"integer\"},{\"name\":\"smart_proxy_name\",\"type\":\"string\"},{\"name\":\"subpath\",\"type\":\"string\"},{\"name\":\"upstream_username\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/alternate_content_sources/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/alternate_content_sources/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an alternate content source.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eAlternate + content source ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/alternate_content_sources/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/alternate_content_sources\",\"http_method\":\"POST\",\"short_description\":\"Create + an alternate content source to download content from during repository syncing. + \ Note: alternate content sources are global and affect ALL sync actions on + their capsules regardless of organization.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003eThe + content type for the Alternate Content Source\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003efile\\u003c/code\\u003e, \\u003ccode\\u003eyum\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"alternate_content_source_type\",\"full_name\":\"alternate_content_source_type\",\"description\":\"\\n\\u003cp\\u003eThe + Alternate Content Source type\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ecustom\\u003c/code\\u003e, \\u003ccode\\u003esimplified\\u003c/code\\u003e, + \\u003ccode\\u003erhui\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the alternate content source\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eDescription + for the alternate content source\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"base_url\",\"full_name\":\"base_url\",\"description\":\"\\n\\u003cp\\u003eBase + URL for finding alternate content\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subpaths\",\"full_name\":\"subpaths\",\"description\":\"\\n\\u003cp\\u003ePath + suffixes for finding alternate content\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy_ids\",\"full_name\":\"smart_proxy_ids\",\"description\":\"\\n\\u003cp\\u003eIds + of capsules to associate\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy_names\",\"full_name\":\"smart_proxy_names\",\"description\":\"\\n\\u003cp\\u003eNames + of capsules to associate\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_username\",\"full_name\":\"upstream_username\",\"description\":\"\\n\\u003cp\\u003eBasic + authentication username\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_password\",\"full_name\":\"upstream_password\",\"description\":\"\\n\\u003cp\\u003eBasic + authentication password\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_ca_cert_id\",\"full_name\":\"ssl_ca_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL CA Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_cert_id\",\"full_name\":\"ssl_client_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL Client Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_key_id\",\"full_name\":\"ssl_client_key_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL Client Key\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"verify_ssl\",\"full_name\":\"verify_ssl\",\"description\":\"\\n\\u003cp\\u003eIf + SSL should be verified for the upstream URL\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"use_http_proxies\",\"full_name\":\"use_http_proxies\",\"description\":\"\\n\\u003cp\\u003eIf + the capsules\\u0026#39; assigned HTTP Proxies should be used\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_ids\",\"full_name\":\"product_ids\",\"description\":\"\\n\\u003cp\\u003eIDs + of products to copy repository information from into a Simplified Alternate + Content Source. Products must include at least one repository of the chosen + content type.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/alternate_content_sources/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/alternate_content_sources/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an alternate content source.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the alternate content source\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eDescription + for the alternate content source\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"base_url\",\"full_name\":\"base_url\",\"description\":\"\\n\\u003cp\\u003eBase + URL for finding alternate content\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subpaths\",\"full_name\":\"subpaths\",\"description\":\"\\n\\u003cp\\u003ePath + suffixes for finding alternate content\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy_ids\",\"full_name\":\"smart_proxy_ids\",\"description\":\"\\n\\u003cp\\u003eIds + of capsules to associate\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy_names\",\"full_name\":\"smart_proxy_names\",\"description\":\"\\n\\u003cp\\u003eNames + of capsules to associate\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_username\",\"full_name\":\"upstream_username\",\"description\":\"\\n\\u003cp\\u003eBasic + authentication username\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_password\",\"full_name\":\"upstream_password\",\"description\":\"\\n\\u003cp\\u003eBasic + authentication password\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_ca_cert_id\",\"full_name\":\"ssl_ca_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL CA Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_cert_id\",\"full_name\":\"ssl_client_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL Client Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_key_id\",\"full_name\":\"ssl_client_key_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL Client Key\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"verify_ssl\",\"full_name\":\"verify_ssl\",\"description\":\"\\n\\u003cp\\u003eIf + SSL should be verified for the upstream URL\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"use_http_proxies\",\"full_name\":\"use_http_proxies\",\"description\":\"\\n\\u003cp\\u003eIf + the capsules\\u0026#39; assigned HTTP Proxies should be used\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_ids\",\"full_name\":\"product_ids\",\"description\":\"\\n\\u003cp\\u003eIDs + of products to copy repository information from into a Simplified Alternate + Content Source. Products must include at least one repository of the chosen + content type.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eAlternate + content source ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/alternate_content_sources/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/alternate_content_sources/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Destroy + an alternate content source.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eAlternate + content source ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/alternate_content_sources/refresh\",\"name\":\"refresh\",\"apis\":[{\"api_url\":\"/katello/api/alternate_content_sources/:id/refresh\",\"http_method\":\"POST\",\"short_description\":\"Refresh + an alternate content source. Refreshing, like repository syncing, is required + before using an alternate content source.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eAlternate + content source ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"ansible_collections\":{\"doc_url\":\"/apidoc/v2/ansible_collections\",\"id\":\"ansible_collections\",\"api_url\":\"/api\",\"name\":\"Ansible + Collections\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/ansible_collections/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/ansible_collections\",\"http_method\":\"GET\",\"short_description\":\"List + ansible_collections\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:filter_id/ansible_collections\",\"http_method\":\"GET\",\"short_description\":\"List + ansible_collections\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/ansible_collections\",\"http_method\":\"GET\",\"short_description\":\"List + ansible_collections\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/ansible_collections\",\"http_method\":\"GET\",\"short_description\":\"List + ansible_collections\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003econtent + view version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_rule_id\",\"full_name\":\"content_view_filter_rule_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter rule identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eids + to filter content by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_filter_ids\",\"full_name\":\"include_filter_ids\",\"description\":\"\\n\\u003cp\\u003eIncludes + associated content view filter ids in response\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_collections/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/ansible_collections/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an ansible collection\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/ansible_collections/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an ansible collection\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003ean + ansible collection identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ansible_collections/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/ansible_collections/compare\",\"http_method\":\"GET\",\"short_description\":\"List + :resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"capsule_content\":{\"doc_url\":\"/apidoc/v2/capsule_content\",\"id\":\"capsule_content\",\"api_url\":\"/api\",\"name\":\"Capsule_content\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/capsule_content/counts\",\"name\":\"counts\",\"apis\":[{\"api_url\":\"/katello/api/capsules/:id/content/counts\",\"http_method\":\"GET\",\"short_description\":\"List + content counts for the capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the capsule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/capsule_content/update_counts\",\"name\":\"update_counts\",\"apis\":[{\"api_url\":\"/katello/api/capsules/:id/content/update_counts\",\"http_method\":\"POST\",\"short_description\":\"Update + content counts for the capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the capsule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/capsule_content/lifecycle_environments\",\"name\":\"lifecycle_environments\",\"apis\":[{\"api_url\":\"/katello/api/capsules/:id/content/lifecycle_environments\",\"http_method\":\"GET\",\"short_description\":\"List + the lifecycle environments attached to the capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the capsule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eId + of the organization to limit environments on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/capsule_content/available_lifecycle_environments\",\"name\":\"available_lifecycle_environments\",\"apis\":[{\"api_url\":\"/katello/api/capsules/:id/content/available_lifecycle_environments\",\"http_method\":\"GET\",\"short_description\":\"List + the lifecycle environments not attached to the capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the capsule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eId + of the organization to limit environments on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/capsule_content/add_lifecycle_environment\",\"name\":\"add_lifecycle_environment\",\"apis\":[{\"api_url\":\"/katello/api/capsules/:id/content/lifecycle_environments\",\"http_method\":\"POST\",\"short_description\":\"Add + lifecycle environments to the capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the capsule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eId + of the lifecycle environment\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/capsule_content/remove_lifecycle_environment\",\"name\":\"remove_lifecycle_environment\",\"apis\":[{\"api_url\":\"/katello/api/capsules/:id/content/lifecycle_environments/:environment_id\",\"http_method\":\"DELETE\",\"short_description\":\"Remove + lifecycle environments from the capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the capsule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eId + of the lifecycle environment\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/capsule_content/sync\",\"name\":\"sync\",\"apis\":[{\"api_url\":\"/katello/api/capsules/:id/content/sync\",\"http_method\":\"POST\",\"short_description\":\"Synchronize + the content to the capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the capsule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eId + of the environment to limit the synchronization on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003eId + of the content view to limit the synchronization on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eId + of the repository to limit the synchronization on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"skip_metadata_check\",\"full_name\":\"skip_metadata_check\",\"description\":\"\\n\\u003cp\\u003eSkip + metadata check on each repository on the capsule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/capsule_content/sync_status\",\"name\":\"sync_status\",\"apis\":[{\"api_url\":\"/katello/api/capsules/:id/content/sync\",\"http_method\":\"GET\",\"short_description\":\"Get + current capsule synchronization status\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the capsule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eId + of the organization to get the status for\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/capsule_content/cancel_sync\",\"name\":\"cancel_sync\",\"apis\":[{\"api_url\":\"/katello/api/capsules/:id/content/sync\",\"http_method\":\"DELETE\",\"short_description\":\"Cancel + running capsule synchronization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the capsule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/capsule_content/reclaim_space\",\"name\":\"reclaim_space\",\"apis\":[{\"api_url\":\"/katello/api/capsules/:id/content/reclaim_space\",\"http_method\":\"POST\",\"short_description\":\"Reclaim + space from all On Demand repositories on a capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the capsule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"capsules\":{\"doc_url\":\"/apidoc/v2/capsules\",\"id\":\"capsules\",\"api_url\":\"/api\",\"name\":\"Capsules\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/capsules/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/capsules\",\"http_method\":\"GET\",\"short_description\":\"List + all capsules that have content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/capsules/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/capsules/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + the capsule details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the capsule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"content_credentials\":{\"doc_url\":\"/apidoc/v2/content_credentials\",\"id\":\"content_credentials\",\"api_url\":\"/api\",\"name\":\"Content_credentials\",\"short_description\":null,\"full_description\":\"\\n\\u003cp\\u003e# + Description\\u003c/p\\u003e\\n\\n\\u003cp\\u003eContent Credentials are used + to store credentials like GPG Keys and Certificates for the authentication + to Products / Repositories.\\u003c/p\\u003e\\n\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/content_credentials/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/content_credentials\",\"http_method\":\"GET\",\"short_description\":\"List + Content Credentials\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the Content Credential\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003eType + of content\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_credentials/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/content_credentials\",\"http_method\":\"POST\",\"short_description\":\"Create + a Content Credential\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the Content Credential\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003eType + of content: \u201Ccert\u201D, \u201Cgpg_key\u201D\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content\",\"full_name\":\"content\",\"description\":\"\\n\\u003cp\\u003ePublic + key block in DER encoding or certificate content\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_credentials/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/content_credentials/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a Content Credential\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + Credential numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_credentials/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/content_credentials/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a Content Credential\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + Credential ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the Content Credential\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003eType + of content: \u201Ccert\u201D, \u201Cgpg_key\u201D\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content\",\"full_name\":\"content\",\"description\":\"\\n\\u003cp\\u003ePublic + key block in DER encoding or certificate content\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_credentials/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/content_credentials/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Destroy + a Content Credential\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + Credential ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_credentials/content\",\"name\":\"content\",\"apis\":[{\"api_url\":\"/katello/api/content_credentials/:id/content\",\"http_method\":\"GET\",\"short_description\":\"Return + the content of a Content Credential, used directly by yum\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_credentials/set_content\",\"name\":\"set_content\",\"apis\":[{\"api_url\":\"/katello/api/content_credentials/:id/content\",\"http_method\":\"POST\",\"short_description\":\"Upload + Content Credential contents\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + Credential ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content\",\"full_name\":\"content\",\"description\":\"\\n\\u003cp\\u003eFile + contents\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"File\",\"expected_type\":\"file\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"content_export_incrementals\":{\"doc_url\":\"/apidoc/v2/content_export_incrementals\",\"id\":\"content_export_incrementals\",\"api_url\":\"/api\",\"name\":\"Content_export_incrementals\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/content_export_incrementals/version\",\"name\":\"version\",\"apis\":[{\"api_url\":\"/katello/api/content_export_incrementals/version\",\"http_method\":\"POST\",\"short_description\":\"Performs + an incremental-export of a content view version.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view version identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"fail_on_missing_content\",\"full_name\":\"fail_on_missing_content\",\"description\":\"\\n\\u003cp\\u003eFails + if any of the repositories belonging to this version are unexportable. False + by default.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"destination_server\",\"full_name\":\"destination_server\",\"description\":\"\\n\\u003cp\\u003eDestination + Server name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"chunk_size_gb\",\"full_name\":\"chunk_size_gb\",\"description\":\"\\n\\u003cp\\u003eSplit + the exported content into archives no greater than the specified size in gigabytes.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"format\",\"full_name\":\"format\",\"description\":\"\\n\\u003cp\\u003eExport + formats.Choose syncable if the exported content needs to be in a yum format. + This option is only available for yum, file repositories. Choose importable + if the importing server uses the same version and exported content needs + to be one of yum, file, ansible_collection, docker repositories.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003esyncable\\u003c/code\\u003e, \\u003ccode\\u003eimportable\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"from_history_id\",\"full_name\":\"from_history_id\",\"description\":\"\\n\\u003cp\\u003eExport + history identifier used for incremental export. If not provided the most recent + export history will be used.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_export_incrementals/library\",\"name\":\"library\",\"apis\":[{\"api_url\":\"/katello/api/content_export_incrementals/library\",\"http_method\":\"POST\",\"short_description\":\"Performs + an incremental-export of the repositories in library.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"fail_on_missing_content\",\"full_name\":\"fail_on_missing_content\",\"description\":\"\\n\\u003cp\\u003eFails + if any of the repositories belonging to this organization are unexportable. + False by default.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"destination_server\",\"full_name\":\"destination_server\",\"description\":\"\\n\\u003cp\\u003eDestination + Server name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"chunk_size_gb\",\"full_name\":\"chunk_size_gb\",\"description\":\"\\n\\u003cp\\u003eSplit + the exported content into archives no greater than the specified size in gigabytes.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"format\",\"full_name\":\"format\",\"description\":\"\\n\\u003cp\\u003eExport + formats.Choose syncable if the exported content needs to be in a yum format. + This option is only available for yum, file repositories. Choose importable + if the importing server uses the same version and exported content needs + to be one of yum, file, ansible_collection, docker repositories.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003esyncable\\u003c/code\\u003e, \\u003ccode\\u003eimportable\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"from_history_id\",\"full_name\":\"from_history_id\",\"description\":\"\\n\\u003cp\\u003eExport + history identifier used for incremental export. If not provided the most recent + export history will be used.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_export_incrementals/repository\",\"name\":\"repository\",\"apis\":[{\"api_url\":\"/katello/api/content_export_incrementals/repository\",\"http_method\":\"POST\",\"short_description\":\"Performs + a incremental-export of the repository in library.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eRepository + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"chunk_size_gb\",\"full_name\":\"chunk_size_gb\",\"description\":\"\\n\\u003cp\\u003eSplit + the exported content into archives no greater than the specified size in gigabytes.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"format\",\"full_name\":\"format\",\"description\":\"\\n\\u003cp\\u003eExport + formats.Choose syncable if the exported content needs to be in a yum format. + This option is only available for yum, file repositories. Choose importable + if the importing server uses the same version and exported content needs + to be one of yum, file, ansible_collection, docker repositories.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003esyncable\\u003c/code\\u003e, \\u003ccode\\u003eimportable\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"from_history_id\",\"full_name\":\"from_history_id\",\"description\":\"\\n\\u003cp\\u003eExport + history identifier used for incremental export. If not provided the most recent + export history will be used.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"content_exports\":{\"doc_url\":\"/apidoc/v2/content_exports\",\"id\":\"content_exports\",\"api_url\":\"/api\",\"name\":\"Content_exports\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/content_exports/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/content_exports\",\"http_method\":\"GET\",\"short_description\":\"List + export histories\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003eContent + view version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003eContent + view identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"destination_server\",\"full_name\":\"destination_server\",\"description\":\"\\n\\u003cp\\u003eDestination + Server name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view version export history identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"type\",\"description\":\"\\n\\u003cp\\u003eExport + Types\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ecomplete\\u003c/code\\u003e, \\u003ccode\\u003eincremental\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"content_view_id\",\"type\":\"integer\"},{\"name\":\"content_view_version_id\",\"type\":\"integer\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"type\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_exports/version\",\"name\":\"version\",\"apis\":[{\"api_url\":\"/katello/api/content_exports/version\",\"http_method\":\"POST\",\"short_description\":\"Performs + a full-export of a content view version.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view version identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"fail_on_missing_content\",\"full_name\":\"fail_on_missing_content\",\"description\":\"\\n\\u003cp\\u003eFails + if any of the repositories belonging to this version are unexportable. False + by default.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"destination_server\",\"full_name\":\"destination_server\",\"description\":\"\\n\\u003cp\\u003eDestination + Server name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"chunk_size_gb\",\"full_name\":\"chunk_size_gb\",\"description\":\"\\n\\u003cp\\u003eSplit + the exported content into archives no greater than the specified size in gigabytes.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"format\",\"full_name\":\"format\",\"description\":\"\\n\\u003cp\\u003eExport + formats.Choose syncable if the exported content needs to be in a yum format. + This option is only available for yum, file repositories. Choose importable + if the importing server uses the same version and exported content needs + to be one of yum, file, ansible_collection, docker repositories.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003esyncable\\u003c/code\\u003e, \\u003ccode\\u003eimportable\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_exports/library\",\"name\":\"library\",\"apis\":[{\"api_url\":\"/katello/api/content_exports/library\",\"http_method\":\"POST\",\"short_description\":\"Performs + a full-export of the repositories in library.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"fail_on_missing_content\",\"full_name\":\"fail_on_missing_content\",\"description\":\"\\n\\u003cp\\u003eFails + if any of the repositories belonging to this organization are unexportable. + False by default.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"destination_server\",\"full_name\":\"destination_server\",\"description\":\"\\n\\u003cp\\u003eDestination + Server name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"chunk_size_gb\",\"full_name\":\"chunk_size_gb\",\"description\":\"\\n\\u003cp\\u003eSplit + the exported content into archives no greater than the specified size in gigabytes.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"format\",\"full_name\":\"format\",\"description\":\"\\n\\u003cp\\u003eExport + formats.Choose syncable if the exported content needs to be in a yum format. + This option is only available for yum, file repositories. Choose importable + if the importing server uses the same version and exported content needs + to be one of yum, file, ansible_collection, docker repositories.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003esyncable\\u003c/code\\u003e, \\u003ccode\\u003eimportable\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_exports/repository\",\"name\":\"repository\",\"apis\":[{\"api_url\":\"/katello/api/content_exports/repository\",\"http_method\":\"POST\",\"short_description\":\"Performs + a full-export of the repository in library.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eRepository + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"chunk_size_gb\",\"full_name\":\"chunk_size_gb\",\"description\":\"\\n\\u003cp\\u003eSplit + the exported content into archives no greater than the specified size in gigabytes.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"format\",\"full_name\":\"format\",\"description\":\"\\n\\u003cp\\u003eExport + formats.Choose syncable if the exported content needs to be in a yum format. + This option is only available for yum, file repositories. Choose importable + if the importing server uses the same version and exported content needs + to be one of yum, file, ansible_collection, docker repositories.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003esyncable\\u003c/code\\u003e, \\u003ccode\\u003eimportable\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"content_imports\":{\"doc_url\":\"/apidoc/v2/content_imports\",\"id\":\"content_imports\",\"api_url\":\"/api\",\"name\":\"Content_imports\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/content_imports/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/content_imports\",\"http_method\":\"GET\",\"short_description\":\"List + import histories\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003eContent + view version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003eContent + view identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view version import history identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"type\",\"description\":\"\\n\\u003cp\\u003eImport + Types\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ecomplete\\u003c/code\\u003e, \\u003ccode\\u003eincremental\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"content_view_id\",\"type\":\"integer\"},{\"name\":\"content_view_version_id\",\"type\":\"integer\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"type\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_imports/version\",\"name\":\"version\",\"apis\":[{\"api_url\":\"/katello/api/content_imports/version\",\"http_method\":\"POST\",\"short_description\":\"Import + a content view version\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"path\",\"full_name\":\"path\",\"description\":\"\\n\\u003cp\\u003eDirectory + containing the exported Content View Version\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"metadata\",\"full_name\":\"metadata\",\"description\":\"\\n\\u003cp\\u003eMetadata + taken from the upstream export history for this Content View Version\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_imports/library\",\"name\":\"library\",\"apis\":[{\"api_url\":\"/katello/api/content_imports/library\",\"http_method\":\"POST\",\"short_description\":\"Import + a content view version to the library\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"path\",\"full_name\":\"path\",\"description\":\"\\n\\u003cp\\u003eDirectory + containing the exported Content View Version\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"metadata\",\"full_name\":\"metadata\",\"description\":\"\\n\\u003cp\\u003eMetadata + taken from the upstream export history for this Content View Version\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_imports/repository\",\"name\":\"repository\",\"apis\":[{\"api_url\":\"/katello/api/content_imports/repository\",\"http_method\":\"POST\",\"short_description\":\"Import + a repository\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"path\",\"full_name\":\"path\",\"description\":\"\\n\\u003cp\\u003eDirectory + containing the exported Content View Version\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"metadata\",\"full_name\":\"metadata\",\"description\":\"\\n\\u003cp\\u003eMetadata + taken from the upstream export history for this Content View Version\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"content_uploads\":{\"doc_url\":\"/apidoc/v2/content_uploads\",\"id\":\"content_uploads\",\"api_url\":\"/api\",\"name\":\"Content_uploads\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/content_uploads/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:repository_id/content_uploads\",\"http_method\":\"POST\",\"short_description\":\"Create + an upload request\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"size\",\"full_name\":\"size\",\"description\":\"\\n\\u003cp\\u003eSize + of file to upload\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"checksum\",\"full_name\":\"checksum\",\"description\":\"\\n\\u003cp\\u003eChecksum + of file to upload\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003econtent + type (\\u0026#39;deb\\u0026#39;, \\u0026#39;docker_manifest\\u0026#39;, \\u0026#39;file\\u0026#39;, + \\u0026#39;ostree_ref\\u0026#39;, \\u0026#39;rpm\\u0026#39;, \\u0026#39;srpm\\u0026#39;)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003edeb\\u003c/code\\u003e, \\u003ccode\\u003edocker_manifest\\u003c/code\\u003e, + \\u003ccode\\u003efile\\u003c/code\\u003e, \\u003ccode\\u003eostree_ref\\u003c/code\\u003e, + \\u003ccode\\u003epython_package\\u003c/code\\u003e, \\u003ccode\\u003erpm\\u003c/code\\u003e, + \\u003ccode\\u003esrpm\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_uploads/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:repository_id/content_uploads/:id\",\"http_method\":\"PUT\",\"short_description\":\"Upload + a chunk of the file's content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eRepository + id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eUpload + request id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"size\",\"full_name\":\"size\",\"description\":\"\\n\\u003cp\\u003eSize + of file to upload\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"offset\",\"full_name\":\"offset\",\"description\":\"\\n\\u003cp\\u003eThe + offset in the file where the content starts\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content\",\"full_name\":\"content\",\"description\":\"\\n\\u003cp\\u003eThe + actual file contents\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"File\",\"expected_type\":\"file\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_uploads/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:repository_id/content_uploads/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + an upload request\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eRepository + id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eUpload + request id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"content_view_components\":{\"doc_url\":\"/apidoc/v2/content_view_components\",\"id\":\"content_view_components\",\"api_url\":\"/api\",\"name\":\"Content_view_components\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/content_view_components/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:composite_content_view_id/content_view_components\",\"http_method\":\"GET\",\"short_description\":\"List + components attached to this content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"composite_content_view_id\",\"full_name\":\"composite_content_view_id\",\"description\":\"\\n\\u003cp\\u003ecomposite + content view identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_components/add_components\",\"name\":\"add_components\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:composite_content_view_id/content_view_components/add\",\"http_method\":\"PUT\",\"short_description\":\"Add + components to the content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"composite_content_view_id\",\"full_name\":\"composite_content_view_id\",\"description\":\"\\n\\u003cp\\u003ecomposite + content view identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"components\",\"full_name\":\"components\",\"description\":\"\\n\\u003cp\\u003eArray + of components to add\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"content_view_version_id\",\"full_name\":\"components[content_view_version_id]\",\"description\":\"\\n\\u003cp\\u003eidentifier + of the version of the component content view\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"components[content_view_id]\",\"description\":\"\\n\\u003cp\\u003econtent + view identifier of the component who\\u0026#39;s latest version is desired\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"latest\",\"full_name\":\"components[latest]\",\"description\":\"\\n\\u003cp\\u003etrue + if the latest version of the component\\u0026#39;s content view is desired\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_components/remove_components\",\"name\":\"remove_components\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:composite_content_view_id/content_view_components/remove\",\"http_method\":\"PUT\",\"short_description\":\"Remove + components from the content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"composite_content_view_id\",\"full_name\":\"composite_content_view_id\",\"description\":\"\\n\\u003cp\\u003ecomposite + content view identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"component_ids\",\"full_name\":\"component_ids\",\"description\":\"\\n\\u003cp\\u003eArray + of content view component IDs to remove. Identifier of the component association\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_components/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:composite_content_view_id/content_view_components/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a content view component\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"composite_content_view_id\",\"full_name\":\"composite_content_view_id\",\"description\":\"\\n\\u003cp\\u003ecomposite + content view numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003econtent + view component ID. Identifier of the component association\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_components/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:composite_content_view_id/content_view_components/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a component associated with the content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"composite_content_view_id\",\"full_name\":\"composite_content_view_id\",\"description\":\"\\n\\u003cp\\u003ecomposite + content view identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003econtent + view component ID. Identifier of the component association\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003eidentifier + of the version of the component content view\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"latest\",\"full_name\":\"latest\",\"description\":\"\\n\\u003cp\\u003etrue + if the latest version of the components content view is desired\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"content_view_filter_rules\":{\"doc_url\":\"/apidoc/v2/content_view_filter_rules\",\"id\":\"content_view_filter_rules\",\"api_url\":\"/api\",\"name\":\"Content_view_filter_rules\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/content_view_filter_rules/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/rules\",\"http_method\":\"GET\",\"short_description\":\"List + filter rules\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003efilter + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003ename + of the content view filter rule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"errata_id\",\"full_name\":\"errata_id\",\"description\":\"\\n\\u003cp\\u003eerrata_id + of the content view filter rule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_filter_rules/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/rules\",\"http_method\":\"POST\",\"short_description\":\"Create + a filter rule. The parameters included should be based upon the filter type.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003efilter + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003edeb, + package, package group, or docker tag names\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of [String]\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"uuid\",\"full_name\":\"uuid\",\"description\":\"\\n\\u003cp\\u003epackage + group: uuid\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"version\",\"description\":\"\\n\\u003cp\\u003epackage: + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture\",\"full_name\":\"architecture\",\"description\":\"\\n\\u003cp\\u003epackage: + architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"min_version\",\"full_name\":\"min_version\",\"description\":\"\\n\\u003cp\\u003epackage: + minimum version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"max_version\",\"full_name\":\"max_version\",\"description\":\"\\n\\u003cp\\u003epackage: + maximum version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"errata_id\",\"full_name\":\"errata_id\",\"description\":\"\\n\\u003cp\\u003eerratum: + id\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"errata_ids\",\"full_name\":\"errata_ids\",\"description\":\"\\n\\u003cp\\u003eerratum: + IDs or a select all object\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"start_date\",\"full_name\":\"start_date\",\"description\":\"\\n\\u003cp\\u003eerratum: + start date (YYYY-MM-DD)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"end_date\",\"full_name\":\"end_date\",\"description\":\"\\n\\u003cp\\u003eerratum: + end date (YYYY-MM-DD)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"types\",\"full_name\":\"types\",\"description\":\"\\n\\u003cp\\u003eerratum: + types (enhancement, bugfix, security)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"date_type\",\"full_name\":\"date_type\",\"description\":\"\\n\\u003cp\\u003eerratum: + search using the \\u0026#39;Issued On\\u0026#39; or \\u0026#39;Updated On\\u0026#39; + column of the errata. Values are \\u0026#39;issued\\u0026#39;/\\u0026#39;updated\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"module_stream_ids\",\"full_name\":\"module_stream_ids\",\"description\":\"\\n\\u003cp\\u003emodule + stream ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_filter_rules/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/rules/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + filter rule info\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003efilter + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003erule + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_filter_rules/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/rules/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a filter rule. The parameters included should be based upon the filter type.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003efilter + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003erule + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003epackage, + package group, or docker tag: name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"version\",\"description\":\"\\n\\u003cp\\u003epackage: + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture\",\"full_name\":\"architecture\",\"description\":\"\\n\\u003cp\\u003epackage: + architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"min_version\",\"full_name\":\"min_version\",\"description\":\"\\n\\u003cp\\u003epackage: + minimum version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"max_version\",\"full_name\":\"max_version\",\"description\":\"\\n\\u003cp\\u003epackage: + maximum version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"errata_id\",\"full_name\":\"errata_id\",\"description\":\"\\n\\u003cp\\u003eerratum: + id\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"start_date\",\"full_name\":\"start_date\",\"description\":\"\\n\\u003cp\\u003eerratum: + start date (YYYY-MM-DD)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"end_date\",\"full_name\":\"end_date\",\"description\":\"\\n\\u003cp\\u003eerratum: + end date (YYYY-MM-DD)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"types\",\"full_name\":\"types\",\"description\":\"\\n\\u003cp\\u003eerratum: + types (enhancement, bugfix, security)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_filter_rules/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/rules/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a filter rule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003efilter + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003erule + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"content_view_filters\":{\"doc_url\":\"/apidoc/v2/content_view_filters\",\"id\":\"content_view_filters\",\"api_url\":\"/api\",\"name\":\"Content_view_filters\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/content_view_filters/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:content_view_id/filters\",\"http_method\":\"get\",\"short_description\":\"list + filters\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters\",\"http_method\":\"get\",\"short_description\":\"list + filters\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003efilter + content view filters by name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"types\",\"full_name\":\"types\",\"description\":\"\\n\\u003cp\\u003etypes + of filters\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"content_type\",\"values\":[\"rpm\",\"deb\",\"package_group\",\"erratum\",\"docker\",\"modulemd\"]},{\"name\":\"inclusion_type\",\"values\":[\"include\",\"exclude\"]},{\"name\":\"name\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_filters/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:content_view_id/filters\",\"http_method\":\"post\",\"short_description\":\"create + a filter for a content view\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters\",\"http_method\":\"post\",\"short_description\":\"create + a filter for a content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003ename + of the filter\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"type\",\"description\":\"\\n\\u003cp\\u003etype + of filter (e.g. deb, rpm, package_group, erratum, erratum_id, erratum_date, + docker, modulemd)\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"original_packages\",\"full_name\":\"original_packages\",\"description\":\"\\n\\u003cp\\u003eadd + all packages without errata to the included/excluded list. (package filter + only)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"original_module_streams\",\"full_name\":\"original_module_streams\",\"description\":\"\\n\\u003cp\\u003eadd + all module streams without errata to the included/excluded list. (module stream + filter only)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"inclusion\",\"full_name\":\"inclusion\",\"description\":\"\\n\\u003cp\\u003especifies + if content should be included or excluded, default: inclusion=false\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_ids\",\"full_name\":\"repository_ids\",\"description\":\"\\n\\u003cp\\u003elist + of repository ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003edescription + of the filter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_filters/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:id\",\"http_method\":\"get\",\"short_description\":\"show + filter info\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:id\",\"http_method\":\"get\",\"short_description\":\"show + filter info\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003efilter + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_filters/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:id\",\"http_method\":\"put\",\"short_description\":\"update + a filter\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:id\",\"http_method\":\"put\",\"short_description\":\"update + a filter\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003efilter + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003enew + name for the filter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"original_packages\",\"full_name\":\"original_packages\",\"description\":\"\\n\\u003cp\\u003eadd + all packages without errata to the included/excluded list. (package filter + only)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"original_module_streams\",\"full_name\":\"original_module_streams\",\"description\":\"\\n\\u003cp\\u003eadd + all module streams without errata to the included/excluded list. (module stream + filter only)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"inclusion\",\"full_name\":\"inclusion\",\"description\":\"\\n\\u003cp\\u003especifies + if content should be included or excluded, default: inclusion=false\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_ids\",\"full_name\":\"repository_ids\",\"description\":\"\\n\\u003cp\\u003elist + of repository ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003edescription + of the filter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_filters/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:id\",\"http_method\":\"delete\",\"short_description\":\"delete + a filter\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:id\",\"http_method\":\"delete\",\"short_description\":\"delete + a filter\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003efilter + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_filters/remove_filter_rules\",\"name\":\"remove_filter_rules\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:id/remove_filter_rules\",\"http_method\":\"put\",\"short_description\":\"bulk + delete filter rules\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:id/remove_filter_rules\",\"http_method\":\"put\",\"short_description\":\"bulk + delete filter rules\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003efilter + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"rule_ids\",\"full_name\":\"rule_ids\",\"description\":\"\\n\\u003cp\\u003efilter + identifiers\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of number\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_filters/add_filter_rules\",\"name\":\"add_filter_rules\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:id/add_filter_rules\",\"http_method\":\"put\",\"short_description\":\"bulk + add filter rules\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:id/add_filter_rules\",\"http_method\":\"put\",\"short_description\":\"bulk + add filter rules\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003efilter + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"rules_params\",\"full_name\":\"rules_params\",\"description\":\"\\n\\u003cp\\u003eRules + to be added\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"rules_params[name]\",\"description\":\"\\n\\u003cp\\u003epackage, + package group, or docker tag names\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of [String]\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"uuid\",\"full_name\":\"rules_params[uuid]\",\"description\":\"\\n\\u003cp\\u003epackage + group: uuid\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"rules_params[version]\",\"description\":\"\\n\\u003cp\\u003epackage: + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture\",\"full_name\":\"rules_params[architecture]\",\"description\":\"\\n\\u003cp\\u003epackage: + architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"min_version\",\"full_name\":\"rules_params[min_version]\",\"description\":\"\\n\\u003cp\\u003epackage: + minimum version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"max_version\",\"full_name\":\"rules_params[max_version]\",\"description\":\"\\n\\u003cp\\u003epackage: + maximum version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"errata_id\",\"full_name\":\"rules_params[errata_id]\",\"description\":\"\\n\\u003cp\\u003eerratum: + id\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"errata_ids\",\"full_name\":\"rules_params[errata_ids]\",\"description\":\"\\n\\u003cp\\u003eerratum: + IDs or a select all object\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"start_date\",\"full_name\":\"rules_params[start_date]\",\"description\":\"\\n\\u003cp\\u003eerratum: + start date (YYYY-MM-DD)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"end_date\",\"full_name\":\"rules_params[end_date]\",\"description\":\"\\n\\u003cp\\u003eerratum: + end date (YYYY-MM-DD)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"types\",\"full_name\":\"rules_params[types]\",\"description\":\"\\n\\u003cp\\u003eerratum: + types (enhancement, bugfix, security)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"date_type\",\"full_name\":\"rules_params[date_type]\",\"description\":\"\\n\\u003cp\\u003eerratum: + search using the \\u0026#39;Issued On\\u0026#39; or \\u0026#39;Updated On\\u0026#39; + column of the errata. Values are \\u0026#39;issued\\u0026#39;/\\u0026#39;updated\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"module_stream_ids\",\"full_name\":\"rules_params[module_stream_ids]\",\"description\":\"\\n\\u003cp\\u003emodule + stream ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"content_view_histories\":{\"doc_url\":\"/apidoc/v2/content_view_histories\",\"id\":\"content_view_histories\",\"api_url\":\"/api\",\"name\":\"Content_view_histories\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/content_view_histories/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:id/history\",\"http_method\":\"GET\",\"short_description\":\"Show + a content view's history\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003econtent + view numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"content_view_versions\":{\"doc_url\":\"/apidoc/v2/content_view_versions\",\"id\":\"content_view_versions\",\"api_url\":\"/api\",\"name\":\"Content_view_versions\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/content_view_versions/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/content_view_versions\",\"http_method\":\"GET\",\"short_description\":\"List + content view versions\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:content_view_id/content_view_versions\",\"http_method\":\"GET\",\"short_description\":\"List + content view versions\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003eContent + view identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eFilter + versions by environment\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"version\",\"description\":\"\\n\\u003cp\\u003eFilter + versions by version number\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"composite_version_id\",\"full_name\":\"composite_version_id\",\"description\":\"\\n\\u003cp\\u003eFilter + versions that are components in the specified composite version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_applied_filters\",\"full_name\":\"include_applied_filters\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to return filters applied to the content view version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"triggered_by_id\",\"full_name\":\"triggered_by_id\",\"description\":\"\\n\\u003cp\\u003eFilter + composite versions whose publish was triggered by the specified component + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"file_id\",\"full_name\":\"file_id\",\"description\":\"\\n\\u003cp\\u003eFilter + content view versions that contain the file\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"nondefault\",\"full_name\":\"nondefault\",\"description\":\"\\n\\u003cp\\u003eFilter + out default content views\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"content_view_id\",\"type\":\"integer\"},{\"name\":\"repository\",\"type\":\"string\"},{\"name\":\"version\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_versions/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/content_view_versions/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + content view version\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view version identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_applied_filters\",\"full_name\":\"include_applied_filters\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to return filters applied to the content view version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_versions/promote\",\"name\":\"promote\",\"apis\":[{\"api_url\":\"/katello/api/content_view_versions/:id/promote\",\"http_method\":\"POST\",\"short_description\":\"Promote + a content view version\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view version identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"force\",\"full_name\":\"force\",\"description\":\"\\n\\u003cp\\u003eforce + content view promotion and bypass lifecycle environment restriction\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_ids\",\"full_name\":\"environment_ids\",\"description\":\"\\n\\u003cp\\u003eIdentifiers + for Lifecycle Environment\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eThe + description for the content view version promotion\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_versions/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/content_view_versions/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a content view version\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view version identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eThe + description for the content view version\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_versions/republish_repositories\",\"name\":\"republish_repositories\",\"apis\":[{\"api_url\":\"/katello/api/content_view_versions/:id/republish_repositories\",\"http_method\":\"PUT\",\"short_description\":\"Forces + a republish of the version's repositories' metadata\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view version identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"force\",\"full_name\":\"force\",\"description\":\"\\n\\u003cp\\u003eForce + metadata regeneration to proceed. Dangerous operation when version has repositories + with the \\u0026#39;Complete Mirroring\\u0026#39; mirroring policy\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_versions/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/content_view_versions/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Remove + content view version\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view version identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_view_versions/incremental_update\",\"name\":\"incremental_update\",\"apis\":[{\"api_url\":\"/katello/api/content_view_versions/incremental_update\",\"http_method\":\"POST\",\"short_description\":\"Perform + an Incremental Update on one or more Content View Versions\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_environments\",\"full_name\":\"content_view_version_environments\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_environments[content_view_version_id]\",\"description\":\"\\n\\u003cp\\u003eContent + View Version Ids to perform an incremental update on. May contain composites + as well as one or more components to update.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_ids\",\"full_name\":\"content_view_version_environments[environment_ids]\",\"description\":\"\\n\\u003cp\\u003eThe + list of environments to promote the specified Content View Version to (replacing + the older version)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eThe + description for the new generated Content View Versions\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"resolve_dependencies\",\"full_name\":\"resolve_dependencies\",\"description\":\"\\n\\u003cp\\u003eIf + true, when adding the specified errata or packages, any needed dependencies + will be copied as well. Defaults to true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"propagate_all_composites\",\"full_name\":\"propagate_all_composites\",\"description\":\"\\n\\u003cp\\u003eIf + true, will publish a new composite version using any specified content_view_version_id + that has been promoted to a lifecycle environment\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"add_content\",\"full_name\":\"add_content\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"errata_ids\",\"full_name\":\"add_content[errata_ids]\",\"description\":\"\\n\\u003cp\\u003eErrata + ids to copy into the new versions\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"package_ids\",\"full_name\":\"add_content[package_ids]\",\"description\":\"\\n\\u003cp\\u003ePackage + ids to copy into the new versions\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"deb_ids\",\"full_name\":\"add_content[deb_ids]\",\"description\":\"\\n\\u003cp\\u003eDeb + Package ids to copy into the new versions\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"update_hosts\",\"full_name\":\"update_hosts\",\"description\":\"\\n\\u003cp\\u003eAfter + generating the incremental update, apply the changes to the specified hosts. + \ Only Errata are supported currently.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"included\",\"full_name\":\"update_hosts[included]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"update_hosts[included][search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for host to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"update_hosts[included][ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"update_hosts[excluded]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"update_hosts[excluded][ids]\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"content_views\":{\"doc_url\":\"/apidoc/v2/content_views\",\"id\":\"content_views\",\"api_url\":\"/api\",\"name\":\"Content_views\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/content_views/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/content_views\",\"http_method\":\"GET\",\"short_description\":\"List + content views\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views\",\"http_method\":\"GET\",\"short_description\":\"List + content views\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"nondefault\",\"full_name\":\"nondefault\",\"description\":\"\\n\\u003cp\\u003eFilter + out default content views\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"noncomposite\",\"full_name\":\"noncomposite\",\"description\":\"\\n\\u003cp\\u003eFilter + out composite content views\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"composite\",\"full_name\":\"composite\",\"description\":\"\\n\\u003cp\\u003eFilter + only composite content views\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"without\",\"full_name\":\"without\",\"description\":\"\\n\\u003cp\\u003eDo + not include this array of content views\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the content view\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"label\",\"full_name\":\"label\",\"description\":\"\\n\\u003cp\\u003eLabel + of the content view\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_generated\",\"full_name\":\"include_generated\",\"description\":\"\\n\\u003cp\\u003eInclude + content views generated by imports/exports. Defaults to false\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"composite\",\"type\":\"boolean\"},{\"name\":\"content_views\",\"type\":\"string\"},{\"name\":\"default\",\"type\":\"boolean\"},{\"name\":\"generated_for\",\"type\":\"integer\"},{\"name\":\"label\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_views/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/content_views\",\"http_method\":\"POST\",\"short_description\":\"Create + a content view\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views\",\"http_method\":\"POST\",\"short_description\":\"Create + a content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the content view\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"label\",\"full_name\":\"label\",\"description\":\"\\n\\u003cp\\u003eContent + view label\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"composite\",\"full_name\":\"composite\",\"description\":\"\\n\\u003cp\\u003eComposite + content view\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eDescription + for the content view\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_ids\",\"full_name\":\"repository_ids\",\"description\":\"\\n\\u003cp\\u003eList + of repository ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"component_ids\",\"full_name\":\"component_ids\",\"description\":\"\\n\\u003cp\\u003eList + of component content view version ids for composite views\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"auto_publish\",\"full_name\":\"auto_publish\",\"description\":\"\\n\\u003cp\\u003eEnable/Disable + auto publish of composite view\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"solve_dependencies\",\"full_name\":\"solve_dependencies\",\"description\":\"\\n\\u003cp\\u003eSolve + RPM dependencies by default on Content View publish, defaults to false\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"import_only\",\"full_name\":\"import_only\",\"description\":\"\\n\\u003cp\\u003eDesignate + this Content View for importing from upstream servers only. Defaults to false\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_views/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eNew + name for the content view\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eDescription + for the content view\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_ids\",\"full_name\":\"repository_ids\",\"description\":\"\\n\\u003cp\\u003eList + of repository ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"component_ids\",\"full_name\":\"component_ids\",\"description\":\"\\n\\u003cp\\u003eList + of component content view version ids for composite views\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"auto_publish\",\"full_name\":\"auto_publish\",\"description\":\"\\n\\u003cp\\u003eEnable/Disable + auto publish of composite view\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"solve_dependencies\",\"full_name\":\"solve_dependencies\",\"description\":\"\\n\\u003cp\\u003eSolve + RPM dependencies by default on Content View publish, defaults to false\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"import_only\",\"full_name\":\"import_only\",\"description\":\"\\n\\u003cp\\u003eDesignate + this Content View for importing from upstream servers only. Defaults to false\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_views/publish\",\"name\":\"publish\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:id/publish\",\"http_method\":\"POST\",\"short_description\":\"Publish + a content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eDescription + for the new published content view version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"major\",\"full_name\":\"major\",\"description\":\"\\n\\u003cp\\u003eOverride + the major version number\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"minor\",\"full_name\":\"minor\",\"description\":\"\\n\\u003cp\\u003eOverride + the minor version number\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_ids\",\"full_name\":\"environment_ids\",\"description\":\"\\n\\u003cp\\u003eIdentifiers + for Lifecycle Environment\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"publish_only_if_needed\",\"full_name\":\"publish_only_if_needed\",\"description\":\"\\n\\u003cp\\u003eCheck + audited changes and proceed only if content or filters have changed since + last publish\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"is_force_promote\",\"full_name\":\"is_force_promote\",\"description\":\"\\n\\u003cp\\u003eForce + content view promotion and bypass lifecycle environment restriction\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repos_units\",\"full_name\":\"repos_units\",\"description\":\"\\n\\u003cp\\u003eSpecify + the list of units in each repo\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"label\",\"full_name\":\"repos_units[label]\",\"description\":\"\\n\\u003cp\\u003erepo + label\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"rpm_filenames\",\"full_name\":\"repos_units[rpm_filenames]\",\"description\":\"\\n\\u003cp\\u003elist + of rpm filename strings to include in published version\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of String\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_views/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003econtent + view numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_views/remove_from_environment\",\"name\":\"remove_from_environment\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:id/environments/:environment_id\",\"http_method\":\"DELETE\",\"short_description\":\"Remove + a content view from an environment\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003econtent + view numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_views/remove\",\"name\":\"remove\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:id/remove\",\"http_method\":\"PUT\",\"short_description\":\"Remove + versions and/or environments from a content view and reassign systems and + keys\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003econtent + view numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_ids\",\"full_name\":\"environment_ids\",\"description\":\"\\n\\u003cp\\u003eenvironment + numeric identifiers to be removed\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of number\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view version identifiers to be deleted\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of number\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"system_content_view_id\",\"full_name\":\"system_content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view to reassign orphaned systems to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"system_environment_id\",\"full_name\":\"system_environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + to reassign orphaned systems to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"key_content_view_id\",\"full_name\":\"key_content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view to reassign orphaned activation keys to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"key_environment_id\",\"full_name\":\"key_environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + to reassign orphaned activation keys to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"destroy_content_view\",\"full_name\":\"destroy_content_view\",\"description\":\"\\n\\u003cp\\u003edelete + the content view with all the versions and environments\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_views/bulk_delete_versions\",\"name\":\"bulk_delete_versions\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:id/bulk_delete_versions\",\"http_method\":\"PUT\",\"short_description\":\"Bulk + remove versions from a content view and reassign systems and keys\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"included\",\"full_name\":\"included\",\"description\":\"\\n\\u003cp\\u003eVersions + to exclusively include in the action\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"search\",\"full_name\":\"included[search]\",\"description\":\"\\n\\u003cp\\u003eSearch + string for versions to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"included[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of versions to perform an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"excluded\",\"full_name\":\"excluded\",\"description\":\"\\n\\u003cp\\u003eVersions + to explicitly exclude in the action. All other versions will be included in + the action, unless an included parameter is passed as well.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"ids\",\"full_name\":\"excluded[ids]\",\"description\":\"\\n\\u003cp\\u003eList + of versions to exclude and not run an action on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003econtent + view numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"system_content_view_id\",\"full_name\":\"system_content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view to reassign orphaned systems to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"system_environment_id\",\"full_name\":\"system_environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + to reassign orphaned systems to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"key_content_view_id\",\"full_name\":\"key_content_view_id\",\"description\":\"\\n\\u003cp\\u003econtent + view to reassign orphaned activation keys to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"key_environment_id\",\"full_name\":\"key_environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + to reassign orphaned activation keys to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_views/remove_filters\",\"name\":\"remove_filters\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:id/remove_filters\",\"http_method\":\"PUT\",\"short_description\":\"Delete + multiple filters from a content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003econtent + view numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"filter_ids\",\"full_name\":\"filter_ids\",\"description\":\"\\n\\u003cp\\u003efilter + identifiers\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of number\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_views/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003econtent + view numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/content_views/copy\",\"name\":\"copy\",\"apis\":[{\"api_url\":\"/katello/api/content_views/:id/copy\",\"http_method\":\"POST\",\"short_description\":\"Make + copy of a content view\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eContent + view numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eNew + content view name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"debs\":{\"doc_url\":\"/apidoc/v2/debs\",\"id\":\"debs\",\"api_url\":\"/api\",\"name\":\"Deb + Packages\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/debs/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/debs\",\"http_method\":\"GET\",\"short_description\":\"List + deb packages\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:filter_id/debs\",\"http_method\":\"GET\",\"short_description\":\"List + deb packages\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/debs\",\"http_method\":\"GET\",\"short_description\":\"List + deb packages\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/debs\",\"http_method\":\"GET\",\"short_description\":\"List + deb packages\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003eContent + View Version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003eContent + View Filter identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eRepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eEnvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eDeb + package identifiers to filter content by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eHost + id to list applicable deb packages for\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"packages_restrict_applicable\",\"full_name\":\"packages_restrict_applicable\",\"description\":\"\\n\\u003cp\\u003eReturn + deb packages that are applicable to one or more hosts (defaults to true if + host_id is specified)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"packages_restrict_upgradable\",\"full_name\":\"packages_restrict_upgradable\",\"description\":\"\\n\\u003cp\\u003eReturn + deb packages that are upgradable on one or more hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"packages_restrict_latest\",\"full_name\":\"packages_restrict_latest\",\"description\":\"\\n\\u003cp\\u003eReturn + only the latest version of each package\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"available_for\",\"full_name\":\"available_for\",\"description\":\"\\n\\u003cp\\u003eReturn + deb packages that can be added to the specified object. Only the value \\u0026#39;content_view_version\\u0026#39; + is supported.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/debs/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/debs/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a deb package\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/debs/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a deb package\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003ea + deb package identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/debs/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/debs/compare\",\"http_method\":\"GET\",\"short_description\":\"List + deb packages\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"docker_manifest_lists\":{\"doc_url\":\"/apidoc/v2/docker_manifest_lists\",\"id\":\"docker_manifest_lists\",\"api_url\":\"/api\",\"name\":\"Docker_manifest_lists\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/docker_manifest_lists/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/docker_manifest_lists\",\"http_method\":\"GET\",\"short_description\":\"List + docker_manifest_lists\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifest_lists\",\"http_method\":\"GET\",\"short_description\":\"List + docker_manifest_lists\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/docker_manifest_lists\",\"http_method\":\"GET\",\"short_description\":\"List + docker_manifest_lists\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/docker_manifest_lists\",\"http_method\":\"GET\",\"short_description\":\"List + docker_manifest_lists\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003econtent + view version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_rule_id\",\"full_name\":\"content_view_filter_rule_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter rule identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eids + to filter content by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_filter_ids\",\"full_name\":\"include_filter_ids\",\"description\":\"\\n\\u003cp\\u003eIncludes + associated content view filter ids in response\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/docker_manifest_lists/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/docker_manifest_lists/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a docker manifest list\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/docker_manifest_lists/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a docker manifest list\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003ea + docker manifest list identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/docker_manifest_lists/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/docker_manifest_lists/compare\",\"http_method\":\"GET\",\"short_description\":\"List + docker_manifest_lists\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"docker_manifests\":{\"doc_url\":\"/apidoc/v2/docker_manifests\",\"id\":\"docker_manifests\",\"api_url\":\"/api\",\"name\":\"Docker_manifests\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/docker_manifests/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/docker_manifests\",\"http_method\":\"GET\",\"short_description\":\"List + docker_manifests\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifests\",\"http_method\":\"GET\",\"short_description\":\"List + docker_manifests\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/docker_manifests\",\"http_method\":\"GET\",\"short_description\":\"List + docker_manifests\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/docker_manifests\",\"http_method\":\"GET\",\"short_description\":\"List + docker_manifests\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003econtent + view version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_rule_id\",\"full_name\":\"content_view_filter_rule_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter rule identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eids + to filter content by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_filter_ids\",\"full_name\":\"include_filter_ids\",\"description\":\"\\n\\u003cp\\u003eIncludes + associated content view filter ids in response\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/docker_manifests/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/docker_manifests/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a docker manifest\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/docker_manifests/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a docker manifest\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003ea + docker manifest identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/docker_manifests/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/docker_manifests/compare\",\"http_method\":\"GET\",\"short_description\":\"List + docker_manifests\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"docker_tags\":{\"doc_url\":\"/apidoc/v2/docker_tags\",\"id\":\"docker_tags\",\"api_url\":\"/api\",\"name\":\"Docker_tags\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/docker_tags/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/docker_tags\",\"http_method\":\"GET\",\"short_description\":\"List + docker_tags\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_tags\",\"http_method\":\"GET\",\"short_description\":\"List + docker_tags\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/docker_tags\",\"http_method\":\"GET\",\"short_description\":\"List + docker_tags\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/docker_tags\",\"http_method\":\"GET\",\"short_description\":\"List + docker_tags\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003econtent + view version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_rule_id\",\"full_name\":\"content_view_filter_rule_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter rule identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eids + to filter content by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_filter_ids\",\"full_name\":\"include_filter_ids\",\"description\":\"\\n\\u003cp\\u003eIncludes + associated content view filter ids in response\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/docker_tags/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/docker_tags/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a docker tag\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/docker_tags/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a docker tag\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003ea + docker tag identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/docker_tags/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/docker_tags/compare\",\"http_method\":\"GET\",\"short_description\":\"List + docker_tags\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/docker_tags/repositories\",\"name\":\"repositories\",\"apis\":[{\"api_url\":\"/katello/api/docker_tags/:id/repositories\",\"http_method\":\"GET\",\"short_description\":\"List + of repositories for a docker meta tag\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"lifecycle_environments\":{\"doc_url\":\"/apidoc/v2/lifecycle_environments\",\"id\":\"lifecycle_environments\",\"api_url\":\"/api\",\"name\":\"Lifecycle_environments\",\"short_description\":null,\"full_description\":\"\\n\\u003cp\\u003e# + Description\\u003c/p\\u003e\\n\\n\\u003cp\\u003eAn environment is a basic + organization structure that groups hosts, products, repositories, etc. Every + host belongs to one environment and it\\u0026#39;s isolated inside so that + it can see only content that is in its environment.\\u003c/p\\u003e\\n\\n\\u003cp\\u003e## + Chains\\u003c/p\\u003e\\n\\n\\u003cp\\u003eEnvironments are ordered into chains + and their content (products, repositories, tempaltes, packages) can be moved + to an environment only from its prior environment. You can have for example + chain like:\\u003c/p\\u003e\\n\\n\\u003cpre\\u003eLibrary -\\u0026gt; Development + -\\u0026gt; Testing -\\u0026gt; Production\\u003c/pre\\u003e\\n\\n\\u003cp\\u003eEach + change in an environment is done through a changeset in an action called promotion.\\u003c/p\\u003e\\n\\n\\u003cp\\u003e## + Library\\u003c/p\\u003e\\n\\n\\u003cp\\u003eLibrary is a special environment + that has no ascendant: All the content starts in this environment. More chains + can start from the library environment but no further branching of a chain + is enabled.\\u003c/p\\u003e\\n\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/lifecycle_environments/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/environments\",\"http_method\":\"GET\",\"short_description\":\"List + environments in an organization\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/environments\",\"http_method\":\"GET\",\"short_description\":\"List + environments in an organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"library\",\"full_name\":\"library\",\"description\":\"\\n\\u003cp\\u003eset + true if you want to see only library environments\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003efilter + only environments containing this name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"label\",\"full_name\":\"label\",\"description\":\"\\n\\u003cp\\u003efilter + only environments containing this label\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"label\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/lifecycle_environments/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/environments/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an environment\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/environments/:environment_id\",\"http_method\":\"GET\",\"short_description\":\"Show + an environment\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the environment\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/lifecycle_environments/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/environments\",\"http_method\":\"POST\",\"short_description\":\"Create + an environment\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/environments\",\"http_method\":\"POST\",\"short_description\":\"Create + an environment in an organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003ename + of organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003ename + of the environment\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"label\",\"full_name\":\"label\",\"description\":\"\\n\\u003cp\\u003elabel + of the environment\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003edescription + of the environment\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"registry_name_pattern\",\"full_name\":\"registry_name_pattern\",\"description\":\"\\n\\u003cp\\u003epattern + for container image names\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"registry_unauthenticated_pull\",\"full_name\":\"registry_unauthenticated_pull\",\"description\":\"\\n\\u003cp\\u003eallow + unauthenticed pull of container images\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"prior_id\",\"full_name\":\"prior_id\",\"description\":\"\\n\\u003cp\\u003eID + of an environment that is prior to the new environment in the chain. It has + to be either the ID of Library or the ID of an environment at the end of a + chain.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/lifecycle_environments/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/environments/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an environment\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/environments/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an environment in an organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the environment\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003ename + of the organization\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"new_name\",\"full_name\":\"new_name\",\"description\":\"\\n\\u003cp\\u003enew + name to be given to the environment\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003edescription + of the environment\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"registry_name_pattern\",\"full_name\":\"registry_name_pattern\",\"description\":\"\\n\\u003cp\\u003epattern + for container image names\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"registry_unauthenticated_pull\",\"full_name\":\"registry_unauthenticated_pull\",\"description\":\"\\n\\u003cp\\u003eallow + unauthenticed pull of container images\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"async\",\"full_name\":\"async\",\"description\":\"\\n\\u003cp\\u003eDo + not wait for the update action to finish. Default: true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/lifecycle_environments/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/environments/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Destroy + an environment\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/environments/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Destroy + an environment in an organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the environment\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/lifecycle_environments/paths\",\"name\":\"paths\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/environments/paths\",\"http_method\":\"GET\",\"short_description\":\"List + environment paths\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_source_id\",\"full_name\":\"content_source_id\",\"description\":\"\\n\\u003cp\\u003eShow + whether each lifecycle environment is associated with the given Capsule id.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"permission_type\",\"full_name\":\"permission_type\",\"description\":\"\\n\\u003cp\\u003eThe + associated permission type. One of (readable | promotable) Default: readable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"errata\":{\"doc_url\":\"/apidoc/v2/errata\",\"id\":\"errata\",\"api_url\":\"/api\",\"name\":\"Errata\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/errata/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/errata\",\"http_method\":\"GET\",\"short_description\":\"List + errata\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003eContent + View Version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003eContent + View Filter identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eRepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eEnvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cve\",\"full_name\":\"cve\",\"description\":\"\\n\\u003cp\\u003eCVE + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eHost + id to list applicable errata for\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"errata_restrict_applicable\",\"full_name\":\"errata_restrict_applicable\",\"description\":\"\\n\\u003cp\\u003eReturn + errata that are applicable to one or more hosts (defaults to true if host_id + is specified)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"errata_restrict_installable\",\"full_name\":\"errata_restrict_installable\",\"description\":\"\\n\\u003cp\\u003eReturn + errata that are upgradable on one or more hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"available_for\",\"full_name\":\"available_for\",\"description\":\"\\n\\u003cp\\u003eReturn + errata that can be added to the specified object. The values \\u0026#39;content_view_version\\u0026#39; + and \\u0026#39;content_view_filter are supported.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"bug\",\"type\":\"string\"},{\"name\":\"cve\",\"type\":\"string\"},{\"name\":\"db_id\",\"type\":\"integer\"},{\"name\":\"errata_id\",\"type\":\"string\"},{\"name\":\"errata_type\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"string\"},{\"name\":\"issued\",\"type\":\"date\"},{\"name\":\"modular\",\"values\":[\"true\",\"false\"]},{\"name\":\"package\",\"type\":\"string\"},{\"name\":\"package_name\",\"type\":\"string\"},{\"name\":\"reboot_suggested\",\"type\":\"boolean\"},{\"name\":\"repository\",\"type\":\"string\"},{\"name\":\"severity\",\"type\":\"string\"},{\"name\":\"synopsis\",\"type\":\"string\"},{\"name\":\"title\",\"type\":\"string\"},{\"name\":\"type\",\"type\":\"string\"},{\"name\":\"updated\",\"type\":\"date\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/errata/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/errata/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an erratum\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/errata/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an erratum\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003ean + erratum identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/errata/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/errata/compare\",\"http_method\":\"GET\",\"short_description\":\"List + errata\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"file_units\":{\"doc_url\":\"/apidoc/v2/file_units\",\"id\":\"file_units\",\"api_url\":\"/api\",\"name\":\"Files\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/file_units/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/files\",\"http_method\":\"GET\",\"short_description\":\"List + files\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:filter_id/files\",\"http_method\":\"GET\",\"short_description\":\"List + files\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/files\",\"http_method\":\"GET\",\"short_description\":\"List + files\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/files\",\"http_method\":\"GET\",\"short_description\":\"List + files\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003econtent + view version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_rule_id\",\"full_name\":\"content_view_filter_rule_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter rule identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eids + to filter content by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_filter_ids\",\"full_name\":\"include_filter_ids\",\"description\":\"\\n\\u003cp\\u003eIncludes + associated content view filter ids in response\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/file_units/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/files/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a file\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/files/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a file\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003ea + file identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/file_units/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/files/compare\",\"http_method\":\"GET\",\"short_description\":\"List + :resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"generic_content_units\":{\"doc_url\":\"/apidoc/v2/generic_content_units\",\"id\":\"generic_content_units\",\"api_url\":\"/api\",\"name\":\"Content + Units\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/generic_content_units/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/content_units\",\"http_method\":\"GET\",\"short_description\":\"List + content_units\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:filter_id/content_units\",\"http_method\":\"GET\",\"short_description\":\"List + content_units\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/content_units\",\"http_method\":\"GET\",\"short_description\":\"List + content_units\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/content_units\",\"http_method\":\"GET\",\"short_description\":\"List + content_units\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003ePossible + values:\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003econtent + view version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_rule_id\",\"full_name\":\"content_view_filter_rule_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter rule identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eids + to filter content by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_filter_ids\",\"full_name\":\"include_filter_ids\",\"description\":\"\\n\\u003cp\\u003eIncludes + associated content view filter ids in response\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/generic_content_units/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/content_units/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a content unit\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/content_units/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a content unit\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003ePossible + values:\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003ea + content unit identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/generic_content_units/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/content_units/compare\",\"http_method\":\"GET\",\"short_description\":\"List + :resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003ePossible + values:\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/generic_content_units/default_sort\",\"name\":\"default_sort\",\"apis\":[{\"api_url\":\"/katello/api/ostree_refs\",\"http_method\":\"GET\",\"short_description\":\"List + ostree_refs\",\"deprecated\":null},{\"api_url\":\"/katello/api/ostree_refs/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + ostree ref\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/ostree_refs/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + ostree ref\",\"deprecated\":null},{\"api_url\":\"/katello/api/python_packages\",\"http_method\":\"GET\",\"short_description\":\"List + python_packages\",\"deprecated\":null},{\"api_url\":\"/katello/api/python_packages/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + python package\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/python_packages/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + python package\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003ePossible + values:\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"host_collections\":{\"doc_url\":\"/apidoc/v2/host_collections\",\"id\":\"host_collections\",\"api_url\":\"/api\",\"name\":\"Host_collections\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/host_collections/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/host_collections/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a host collection\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the host collection\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_collections/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/host_collections\",\"http_method\":\"GET\",\"short_description\":\"List + host collections\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/host_collections\",\"http_method\":\"GET\",\"short_description\":\"List + host collections within an organization\",\"deprecated\":null},{\"api_url\":\"/katello/api/activation_keys/:activation_key_id/host_collections\",\"http_method\":\"GET\",\"short_description\":\"List + host collections in an activation key\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003ehost + collection name to filter by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"activation_key_id\",\"full_name\":\"activation_key_id\",\"description\":\"\\n\\u003cp\\u003eactivation + key identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eFilter + products by host id\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"available_for\",\"full_name\":\"available_for\",\"description\":\"\\n\\u003cp\\u003eInterpret + specified object to return only Host Collections that can be associated with + specified object. The value \\u0026#39;host\\u0026#39; is supported.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"host\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_collections/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/host_collections\",\"http_method\":\"POST\",\"short_description\":\"Create + a host collection\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/host_collections\",\"http_method\":\"POST\",\"short_description\":\"Create + a host collection\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eHost + Collection name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"host_ids\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to replace the hosts in host collection\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"max_hosts\",\"full_name\":\"max_hosts\",\"description\":\"\\n\\u003cp\\u003eMaximum + number of hosts in the host collection\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"unlimited_hosts\",\"full_name\":\"unlimited_hosts\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the host collection may have unlimited hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_collections/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/host_collections/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a host collection\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the host collection\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eHost + Collection name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"host_ids\",\"description\":\"\\n\\u003cp\\u003eList + of host ids to replace the hosts in host collection\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"max_hosts\",\"full_name\":\"max_hosts\",\"description\":\"\\n\\u003cp\\u003eMaximum + number of hosts in the host collection\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"unlimited_hosts\",\"full_name\":\"unlimited_hosts\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the host collection may have unlimited hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_collections/add_hosts\",\"name\":\"add_hosts\",\"apis\":[{\"api_url\":\"/katello/api/host_collections/:id/add_hosts\",\"http_method\":\"PUT\",\"short_description\":\"Add + host to the host collection\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the host collection\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"host_ids\",\"description\":\"\\n\\u003cp\\u003eArray + of host ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_collections/remove_hosts\",\"name\":\"remove_hosts\",\"apis\":[{\"api_url\":\"/katello/api/host_collections/:id/remove_hosts\",\"http_method\":\"PUT\",\"short_description\":\"Remove + hosts from the host collection\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the host collection\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"host_ids\",\"description\":\"\\n\\u003cp\\u003eArray + of host ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_collections/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/host_collections/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Destroy + a host collection\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eId + of the host collection\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_collections/copy\",\"name\":\"copy\",\"apis\":[{\"api_url\":\"/katello/api/host_collections/:id/copy\",\"http_method\":\"POST\",\"short_description\":\"Make + copy of a host collection\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the host collection\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eNew + host collection name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"host_debs\":{\"doc_url\":\"/apidoc/v2/host_debs\",\"id\":\"host_debs\",\"api_url\":\"/api\",\"name\":\"Host_debs\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/host_debs/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/debs\",\"http_method\":\"GET\",\"short_description\":\"List + deb packages installed on the host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"host_errata\":{\"doc_url\":\"/apidoc/v2/host_errata\",\"id\":\"host_errata\",\"api_url\":\"/api\",\"name\":\"Host_errata\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/host_errata/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/errata\",\"http_method\":\"GET\",\"short_description\":\"List + errata available for the content host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eUUID + of the content host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003eCalculate + Applicable Errata based on a particular Content View\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eCalculate + Applicable Errata based on a particular Environment\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_applicable\",\"full_name\":\"include_applicable\",\"description\":\"\\n\\u003cp\\u003eReturn + errata that are applicable to this host. Defaults to false)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"type\",\"description\":\"\\n\\u003cp\\u003eReturn + only errata of a particular type (security, bugfix, enhancement)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"severity\",\"full_name\":\"severity\",\"description\":\"\\n\\u003cp\\u003eReturn + only errata of a particular severity (None, Low, Moderate, Important, Critical)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_errata/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/errata/:id\",\"http_method\":\"GET\",\"short_description\":\"Retrieve + a single errata for a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eHost + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eErrata + id of the erratum (RHSA-2012:108)\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_errata/applicability\",\"name\":\"applicability\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/errata/applicability\",\"http_method\":\"PUT\",\"short_description\":\"Force + regenerate applicability.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eHost + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"host_module_streams\":{\"doc_url\":\"/apidoc/v2/host_module_streams\",\"id\":\"host_module_streams\",\"api_url\":\"/api\",\"name\":\"Host_module_streams\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/host_module_streams/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/module_streams\",\"http_method\":\"GET\",\"short_description\":\"List + module streams available to the host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"status\",\"full_name\":\"status\",\"description\":\"\\n\\u003cp\\u003eStreams + based on the host based on their status\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eenabled\\u003c/code\\u003e, \\u003ccode\\u003edisabled\\u003c/code\\u003e, + \\u003ccode\\u003eunknown\\u003c/code\\u003e, \\u003ccode\\u003einstalled\\u003c/code\\u003e, + \\u003ccode\\u003eupgradable\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"install_status\",\"full_name\":\"install_status\",\"description\":\"\\n\\u003cp\\u003eStreams + based on the host based on the installation status\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"host_packages\":{\"doc_url\":\"/apidoc/v2/host_packages\",\"id\":\"host_packages\",\"api_url\":\"/api\",\"name\":\"Host_packages\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/host_packages/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/packages\",\"http_method\":\"GET\",\"short_description\":\"List + packages installed on the host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_latest_upgradable\",\"full_name\":\"include_latest_upgradable\",\"description\":\"\\n\\u003cp\\u003eAlso + include the latest upgradable package version for each host package\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"status\",\"full_name\":\"status\",\"description\":\"\\n\\u003cp\\u003eReturn + only packages of a particular status (upgradable or up-to-date)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"arch\",\"type\":\"string\"},{\"name\":\"epoch\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"nvra\",\"type\":\"string\"},{\"name\":\"nvrea\",\"type\":\"string\"},{\"name\":\"release\",\"type\":\"string\"},{\"name\":\"vendor\",\"type\":\"string\"},{\"name\":\"version\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"host_tracer\":{\"doc_url\":\"/apidoc/v2/host_tracer\",\"id\":\"host_tracer\",\"api_url\":\"/api\",\"name\":\"Host_tracer\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/host_tracer/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/traces\",\"http_method\":\"GET\",\"short_description\":\"List + services that need restarting on the host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/host_tracer/resolve\",\"name\":\"resolve\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/traces/resolve\",\"http_method\":\"PUT\",\"short_description\":\"Resolve + traces\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + of the host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"trace_ids\",\"full_name\":\"trace_ids\",\"description\":\"\\n\\u003cp\\u003eArray + of Trace IDs\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"ping\":{\"doc_url\":\"/apidoc/v2/ping\",\"id\":\"ping\",\"api_url\":\"/api\",\"name\":\"Ping\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/ping/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/ping\",\"http_method\":\"GET\",\"short_description\":\"Shows + status of Katello system and it's subcomponents\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eThis + service is only available for authenticated users\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ping/server_status\",\"name\":\"server_status\",\"apis\":[{\"api_url\":\"/katello/api/status\",\"http_method\":\"GET\",\"short_description\":\"Shows + version information\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eThis + service is available for unauthenticated users\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ping/ping\",\"name\":\"ping\",\"apis\":[{\"api_url\":\"/api/ping\",\"http_method\":\"GET\",\"short_description\":\"Shows + status of Satellite system and it's subcomponents\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eThis + service is available for unauthenticated users\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ping/statuses\",\"name\":\"statuses\",\"apis\":[{\"api_url\":\"/api/statuses\",\"http_method\":\"GET\",\"short_description\":\"Shows + status and version information of Satellite system and it's subcomponents\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eThis + service is only available for authenticated users\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"module_streams\":{\"doc_url\":\"/apidoc/v2/module_streams\",\"id\":\"module_streams\",\"api_url\":\"/api\",\"name\":\"Module_streams\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/module_streams/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/module_streams\",\"http_method\":\"GET\",\"short_description\":\"List + module_streams\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:filter_id/module_streams\",\"http_method\":\"GET\",\"short_description\":\"List + module_streams\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/module_streams\",\"http_method\":\"GET\",\"short_description\":\"List + module_streams\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/module_streams\",\"http_method\":\"GET\",\"short_description\":\"List + module_streams\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003econtent + view version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_rule_id\",\"full_name\":\"content_view_filter_rule_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter rule identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eids + to filter content by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_filter_ids\",\"full_name\":\"include_filter_ids\",\"description\":\"\\n\\u003cp\\u003eIncludes + associated content view filter ids in response\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"host_ids\",\"description\":\"\\n\\u003cp\\u003eList + of host id to list available module streams for\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name_stream_only\",\"full_name\":\"name_stream_only\",\"description\":\"\\n\\u003cp\\u003eReturn + name and stream information only)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/module_streams/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/module_streams/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a module stream\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/module_streams/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a module stream\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003ea + module stream identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/module_streams/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/module_streams/compare\",\"http_method\":\"GET\",\"short_description\":\"List + module_streams\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"organizations\":{\"doc_url\":\"/apidoc/v2/organizations\",\"id\":\"organizations\",\"api_url\":\"/api\",\"name\":\"Organizations\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/organizations/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/organizations\",\"http_method\":\"GET\",\"short_description\":\"List + all organizations\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"description\",\"type\":\"text\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"label\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"title\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/organizations/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eorganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/organizations/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/organizations\",\"http_method\":\"POST\",\"short_description\":\"Create + organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization\",\"full_name\":\"organization\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"organization[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"organization[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_ids\",\"full_name\":\"organization[user_ids]\",\"description\":\"\\n\\u003cp\\u003eUser + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy_ids\",\"full_name\":\"organization[smart_proxy_ids]\",\"description\":\"\\n\\u003cp\\u003eCapsule + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_ids\",\"full_name\":\"organization[compute_resource_ids]\",\"description\":\"\\n\\u003cp\\u003eCompute + resource IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_ids\",\"full_name\":\"organization[medium_ids]\",\"description\":\"\\n\\u003cp\\u003eMedium + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_ids\",\"full_name\":\"organization[ptable_ids]\",\"description\":\"\\n\\u003cp\\u003ePartition + template IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_ids\",\"full_name\":\"organization[provisioning_template_ids]\",\"description\":\"\\n\\u003cp\\u003eProvisioning + template IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_ids\",\"full_name\":\"organization[domain_ids]\",\"description\":\"\\n\\u003cp\\u003eDomain + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_ids\",\"full_name\":\"organization[realm_ids]\",\"description\":\"\\n\\u003cp\\u003eRealm + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_ids\",\"full_name\":\"organization[hostgroup_ids]\",\"description\":\"\\n\\u003cp\\u003eHost + group IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_ids\",\"full_name\":\"organization[environment_ids]\",\"description\":\"\\n\\u003cp\\u003eEnvironment + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_ids\",\"full_name\":\"organization[subnet_ids]\",\"description\":\"\\n\\u003cp\\u003eSubnet + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ignore_types\",\"full_name\":\"organization[ignore_types]\",\"description\":\"\\n\\u003cp\\u003eList + of resources types that will be automatically associated\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"organization[location_ids]\",\"description\":\"\\n\\u003cp\\u003eAssociated + location IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"label\",\"full_name\":\"organization[label]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"simple_content_access\",\"full_name\":\"simple_content_access\",\"description\":\"\\n\\u003cp\\u003eWhether + to turn on Simple Content Access for the organization.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":true}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/organizations/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eorganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"redhat_repository_url\",\"full_name\":\"redhat_repository_url\",\"description\":\"\\n\\u003cp\\u003eRed + Hat CDN URL\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":true},{\"name\":\"simple_content_access\",\"full_name\":\"simple_content_access\",\"description\":\"\\n\\u003cp\\u003eWhether + Simple Content Access should be enabled for the organization.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":true},{\"name\":\"organization\",\"full_name\":\"organization\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"organization[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"organization[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_ids\",\"full_name\":\"organization[user_ids]\",\"description\":\"\\n\\u003cp\\u003eUser + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy_ids\",\"full_name\":\"organization[smart_proxy_ids]\",\"description\":\"\\n\\u003cp\\u003eCapsule + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_ids\",\"full_name\":\"organization[compute_resource_ids]\",\"description\":\"\\n\\u003cp\\u003eCompute + resource IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_ids\",\"full_name\":\"organization[medium_ids]\",\"description\":\"\\n\\u003cp\\u003eMedium + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_ids\",\"full_name\":\"organization[ptable_ids]\",\"description\":\"\\n\\u003cp\\u003ePartition + template IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_ids\",\"full_name\":\"organization[provisioning_template_ids]\",\"description\":\"\\n\\u003cp\\u003eProvisioning + template IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_ids\",\"full_name\":\"organization[domain_ids]\",\"description\":\"\\n\\u003cp\\u003eDomain + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_ids\",\"full_name\":\"organization[realm_ids]\",\"description\":\"\\n\\u003cp\\u003eRealm + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_ids\",\"full_name\":\"organization[hostgroup_ids]\",\"description\":\"\\n\\u003cp\\u003eHost + group IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_ids\",\"full_name\":\"organization[environment_ids]\",\"description\":\"\\n\\u003cp\\u003eEnvironment + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_ids\",\"full_name\":\"organization[subnet_ids]\",\"description\":\"\\n\\u003cp\\u003eSubnet + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ignore_types\",\"full_name\":\"organization[ignore_types]\",\"description\":\"\\n\\u003cp\\u003eList + of resources types that will be automatically associated\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"organization[location_ids]\",\"description\":\"\\n\\u003cp\\u003eAssociated + location IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/organizations/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + an organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/organizations/repo_discover\",\"name\":\"repo_discover\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:id/repo_discover\",\"http_method\":\"PUT\",\"short_description\":\"Discover + Repositories\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"url\",\"description\":\"\\n\\u003cp\\u003eBase + URL to perform repo discovery on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003eOne + of yum or docker\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_username\",\"full_name\":\"upstream_username\",\"description\":\"\\n\\u003cp\\u003eUsername + to access URL\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_password\",\"full_name\":\"upstream_password\",\"description\":\"\\n\\u003cp\\u003ePassword + to access URL\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + pattern (defaults to \\u0026#39;*\\u0026#39;)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/organizations/cancel_repo_discover\",\"name\":\"cancel_repo_discover\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:label/cancel_repo_discover\",\"http_method\":\"PUT\",\"short_description\":\"Cancel + repository discovery\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"label\",\"full_name\":\"label\",\"description\":\"\\n\\u003cp\\u003eOrganization + label\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"url\",\"description\":\"\\n\\u003cp\\u003ebase + url to perform repo discovery on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/organizations/download_debug_certificate\",\"name\":\"download_debug_certificate\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:label/download_debug_certificate\",\"http_method\":\"GET\",\"short_description\":\"Download + a debug certificate\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"label\",\"full_name\":\"label\",\"description\":\"\\n\\u003cp\\u003eOrganization + label\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/organizations/releases\",\"name\":\"releases\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:id/releases\",\"http_method\":\"GET\",\"short_description\":\"List + available releases in the organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the Organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/organizations/cdn_configuration\",\"name\":\"cdn_configuration\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:id/cdn_configuration\",\"http_method\":\"PUT\",\"short_description\":\"Update + the CDN configuration\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the Organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"type\",\"description\":\"\\n\\u003cp\\u003eCDN + configuration type. One of redhat_cdn, network_sync, export_sync, custom_cdn.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"url\",\"description\":\"\\n\\u003cp\\u003eUpstream + satellite server to sync CDN content from. Relevant only for \\u0026#39;upstream_server\\u0026#39; + type.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"username\",\"full_name\":\"username\",\"description\":\"\\n\\u003cp\\u003eUsername + for authentication. Relevant only for \\u0026#39;upstream_server\\u0026#39; + type.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"password\",\"description\":\"\\n\\u003cp\\u003ePassword + for authentication. Relevant only for \\u0026#39;upstream_server\\u0026#39; + type.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_organization_label\",\"full_name\":\"upstream_organization_label\",\"description\":\"\\n\\u003cp\\u003eUpstream + organization to sync CDN content from. Relevant only for \\u0026#39;upstream_server\\u0026#39; + type.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_content_view_label\",\"full_name\":\"upstream_content_view_label\",\"description\":\"\\n\\u003cp\\u003eUpstream + Content View Label, default: Default_Organization_View. Relevant only for + \\u0026#39;upstream_server\\u0026#39; type.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_lifecycle_environment_label\",\"full_name\":\"upstream_lifecycle_environment_label\",\"description\":\"\\n\\u003cp\\u003eUpstream + Lifecycle Environment, default: Library. Relevant only for \\u0026#39;upstream_server\\u0026#39; + type.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_ca_credential_id\",\"full_name\":\"ssl_ca_credential_id\",\"description\":\"\\n\\u003cp\\u003eContent + Credential to use for SSL CA. Relevant only for \\u0026#39;upstream_server\\u0026#39; + type.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"custom_cdn_auth_enabled\",\"full_name\":\"custom_cdn_auth_enabled\",\"description\":\"\\n\\u003cp\\u003eIf + product certificates should be used to authenticate to a custom CDN.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/organizations/redhat_provider\",\"name\":\"redhat_provider\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:id/redhat_provider\",\"http_method\":\"GET\",\"short_description\":\"List + all :resource_id\",\"deprecated\":true}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"package_groups\":{\"doc_url\":\"/apidoc/v2/package_groups\",\"id\":\"package_groups\",\"api_url\":\"/api\",\"name\":\"Package_groups\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/package_groups/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/package_groups\",\"http_method\":\"GET\",\"short_description\":\"List + package_groups\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:filter_id/package_groups\",\"http_method\":\"GET\",\"short_description\":\"List + package_groups\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/package_groups\",\"http_method\":\"GET\",\"short_description\":\"List + package_groups\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/package_groups\",\"http_method\":\"GET\",\"short_description\":\"List + package_groups\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003econtent + view version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_rule_id\",\"full_name\":\"content_view_filter_rule_id\",\"description\":\"\\n\\u003cp\\u003econtent + view filter rule identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eenvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eids + to filter content by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_filter_ids\",\"full_name\":\"include_filter_ids\",\"description\":\"\\n\\u003cp\\u003eIncludes + associated content view filter ids in response\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/package_groups/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/package_groups/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a package group\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/package_groups/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a package group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003ea + package group identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/package_groups/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/package_groups/compare\",\"http_method\":\"GET\",\"short_description\":\"List + package_groups\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"packages\":{\"doc_url\":\"/apidoc/v2/packages\",\"id\":\"packages\",\"api_url\":\"/api\",\"name\":\"Packages\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/packages/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/packages\",\"http_method\":\"GET\",\"short_description\":\"List + packages\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:content_view_id/filters/:filter_id/:resource_id\",\"http_method\":\"GET\",\"short_description\":\"List + :resource_id\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_view_filters/:content_view_filter_id/:resource_id\",\"http_method\":\"GET\",\"short_description\":\"List + :resource_id\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/:resource_id\",\"http_method\":\"GET\",\"short_description\":\"List + :resource_id\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003eContent + View Version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_filter_id\",\"full_name\":\"content_view_filter_id\",\"description\":\"\\n\\u003cp\\u003eContent + View Filter identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eRepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eEnvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003ePackage + identifiers to filter content by\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eHost + id to list applicable packages for\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"packages_restrict_applicable\",\"full_name\":\"packages_restrict_applicable\",\"description\":\"\\n\\u003cp\\u003eReturn + packages that are applicable to one or more hosts (defaults to true if host_id + is specified)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"packages_restrict_upgradable\",\"full_name\":\"packages_restrict_upgradable\",\"description\":\"\\n\\u003cp\\u003eReturn + packages that are upgradable on one or more hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"packages_restrict_latest\",\"full_name\":\"packages_restrict_latest\",\"description\":\"\\n\\u003cp\\u003eReturn + only the latest version of each package\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"available_for\",\"full_name\":\"available_for\",\"description\":\"\\n\\u003cp\\u003eReturn + packages that can be added to the specified object. Only the value \\u0026#39;content_view_version\\u0026#39; + is supported.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/packages/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/packages/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a package\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/packages/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a package\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003ea + package identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/packages/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/packages/compare\",\"http_method\":\"GET\",\"short_description\":\"List + packages\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"products_bulk_actions\":{\"doc_url\":\"/apidoc/v2/products_bulk_actions\",\"id\":\"products_bulk_actions\",\"api_url\":\"/api\",\"name\":\"Products_bulk_actions\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/products_bulk_actions/destroy_products\",\"name\":\"destroy_products\",\"apis\":[{\"api_url\":\"/katello/api/products/bulk/destroy\",\"http_method\":\"PUT\",\"short_description\":\"Destroy + one or more products\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eList + of product ids\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/products_bulk_actions/sync_products\",\"name\":\"sync_products\",\"apis\":[{\"api_url\":\"/katello/api/products/bulk/sync\",\"http_method\":\"PUT\",\"short_description\":\"Sync + one or more products\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eList + of product ids\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"skip_metadata_check\",\"full_name\":\"skip_metadata_check\",\"description\":\"\\n\\u003cp\\u003eForce + sync even if no upstream changes are detected. Non-yum repositories are skipped.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"validate_contents\",\"full_name\":\"validate_contents\",\"description\":\"\\n\\u003cp\\u003eForce + a sync and validate the checksums of all content. Non-yum repositories (or + those with On Demand + download policy) are skipped.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/products_bulk_actions/verify_checksum_products\",\"name\":\"verify_checksum_products\",\"apis\":[{\"api_url\":\"/katello/api/products/bulk/verify_checksum\",\"http_method\":\"PUT\",\"short_description\":\"Verify + checksum for one or more products\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eList + of product ids\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/products_bulk_actions/update_http_proxy\",\"name\":\"update_http_proxy\",\"apis\":[{\"api_url\":\"/katello/api/products/bulk/http_proxy\",\"http_method\":\"PUT\",\"short_description\":\"Update + the HTTP Proxy configuration on the repositories of one or more products.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eList + of product ids\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy_policy\",\"full_name\":\"http_proxy_policy\",\"description\":\"\\n\\u003cp\\u003epolicy + for HTTP Proxy for content sync\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eglobal_default_http_proxy\\u003c/code\\u003e, + \\u003ccode\\u003enone\\u003c/code\\u003e, \\u003ccode\\u003euse_selected_http_proxy\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy_id\",\"full_name\":\"http_proxy_id\",\"description\":\"\\n\\u003cp\\u003eHTTP + Proxy identifier to associated\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/products_bulk_actions/update_sync_plans\",\"name\":\"update_sync_plans\",\"apis\":[{\"api_url\":\"/katello/api/products/bulk/sync_plan\",\"http_method\":\"PUT\",\"short_description\":\"Sync + one or more products\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eList + of product ids\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"plan_id\",\"full_name\":\"plan_id\",\"description\":\"\\n\\u003cp\\u003eSync + plan identifier to attach\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"products\":{\"doc_url\":\"/apidoc/v2/products\",\"id\":\"products\",\"api_url\":\"/api\",\"name\":\"Products\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/products/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/products\",\"http_method\":\"GET\",\"short_description\":\"List + products\",\"deprecated\":null},{\"api_url\":\"/katello/api/subscriptions/:subscription_id/products\",\"http_method\":\"GET\",\"short_description\":\"List + of subscription products in a subscription\",\"deprecated\":null},{\"api_url\":\"/katello/api/activation_keys/:activation_key_id/products\",\"http_method\":\"GET\",\"short_description\":\"List + of subscription products in an activation key\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/products\",\"http_method\":\"GET\",\"short_description\":\"List + of products in an organization\",\"deprecated\":null},{\"api_url\":\"/katello/api/sync_plans/:sync_plan_id/products\",\"http_method\":\"GET\",\"short_description\":\"List + of Products for sync plan\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products\",\"http_method\":\"GET\",\"short_description\":\"List + of Products for sync plan\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eFilter + products by organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subscription_id\",\"full_name\":\"subscription_id\",\"description\":\"\\n\\u003cp\\u003eFilter + products by subscription\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eFilter + products by name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"enabled\",\"description\":\"\\n\\u003cp\\u003eReturn + enabled products only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"custom\",\"full_name\":\"custom\",\"description\":\"\\n\\u003cp\\u003eReturn + custom products only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"redhat_only\",\"full_name\":\"redhat_only\",\"description\":\"\\n\\u003cp\\u003eReturn + Red Hat (non-custom) products only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_available_content\",\"full_name\":\"include_available_content\",\"description\":\"\\n\\u003cp\\u003eWhether + to include available content attribute in results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sync_plan_id\",\"full_name\":\"sync_plan_id\",\"description\":\"\\n\\u003cp\\u003eFilter + products by sync plan id\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"available_for\",\"full_name\":\"available_for\",\"description\":\"\\n\\u003cp\\u003eInterpret + specified object to return only Products that can be associated with specified + object. Only \\u0026#39;sync_plan\\u0026#39; is supported.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"description\",\"type\":\"text\"},{\"name\":\"label\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"redhat\",\"values\":[\"true\",\"false\"]}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/products/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/products\",\"http_method\":\"POST\",\"short_description\":\"Create + a product\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of the organization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eProduct + description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"gpg_key_id\",\"full_name\":\"gpg_key_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the GPG key\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_ca_cert_id\",\"full_name\":\"ssl_ca_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdenifier + of the SSL CA Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_cert_id\",\"full_name\":\"ssl_client_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the SSL Client Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_key_id\",\"full_name\":\"ssl_client_key_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the SSL Client Key\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sync_plan_id\",\"full_name\":\"sync_plan_id\",\"description\":\"\\n\\u003cp\\u003ePlan + numeric identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eProduct + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"label\",\"full_name\":\"label\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/products/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/products/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a product\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eproduct + numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/products/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/products/:id\",\"http_method\":\"PUT\",\"short_description\":\"Updates + a product\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eproduct + numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eProduct + description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"gpg_key_id\",\"full_name\":\"gpg_key_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the GPG key\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_ca_cert_id\",\"full_name\":\"ssl_ca_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdenifier + of the SSL CA Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_cert_id\",\"full_name\":\"ssl_client_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the SSL Client Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_key_id\",\"full_name\":\"ssl_client_key_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the SSL Client Key\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sync_plan_id\",\"full_name\":\"sync_plan_id\",\"description\":\"\\n\\u003cp\\u003ePlan + numeric identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eProduct + name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/products/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/products/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Destroy + a product\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eproduct + numeric identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/products/sync\",\"name\":\"sync\",\"apis\":[{\"api_url\":\"/katello/api/products/:id/sync\",\"http_method\":\"POST\",\"short_description\":\"Sync + all repositories for a product\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eproduct + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"repositories_bulk_actions\":{\"doc_url\":\"/apidoc/v2/repositories_bulk_actions\",\"id\":\"repositories_bulk_actions\",\"api_url\":\"/api\",\"name\":\"Repositories_bulk_actions\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/repositories_bulk_actions/destroy_repositories\",\"name\":\"destroy_repositories\",\"apis\":[{\"api_url\":\"/katello/api/repositories/bulk/destroy\",\"http_method\":\"PUT\",\"short_description\":\"Destroy + one or more repositories\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eList + of repository ids\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories_bulk_actions/sync_repositories\",\"name\":\"sync_repositories\",\"apis\":[{\"api_url\":\"/katello/api/repositories/bulk/sync\",\"http_method\":\"POST\",\"short_description\":\"Synchronize + repository\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eList + of repository ids\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories_bulk_actions/reclaim_space_from_repositories\",\"name\":\"reclaim_space_from_repositories\",\"apis\":[{\"api_url\":\"/katello/api/repositories/bulk/reclaim_space\",\"http_method\":\"POST\",\"short_description\":\"Reclaim + space from On Demand repositories\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eList + of repository ids\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"repositories\":{\"doc_url\":\"/apidoc/v2/repositories\",\"id\":\"repositories\",\"api_url\":\"/api\",\"name\":\"Repositories\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/repositories/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/repositories\",\"http_method\":\"GET\",\"short_description\":\"List + of enabled repositories\",\"deprecated\":null},{\"api_url\":\"/katello/api/content_views/:id/repositories\",\"http_method\":\"GET\",\"short_description\":\"List + of repositories for a content view\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/repositories\",\"http_method\":\"GET\",\"short_description\":\"List + of repositories in an organization\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/environments/:environment_id/repositories\",\"http_method\":\"GET\",\"short_description\":\"List + repositories in the environment\",\"deprecated\":null},{\"api_url\":\"/katello/api/products/:product_id/repositories\",\"http_method\":\"GET\",\"short_description\":\"List + of repositories for a product\",\"deprecated\":null},{\"api_url\":\"/katello/api/environments/:environment_id/products/:product_id/repositories\",\"http_method\":\"GET\",\"short_description\":\"List + of repositories belonging to a product in an environment\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of an organization to show repositories in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_id\",\"full_name\":\"product_id\",\"description\":\"\\n\\u003cp\\u003eID + of a product to show repositories of\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eID + of an environment to show repositories in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_id\",\"full_name\":\"content_view_id\",\"description\":\"\\n\\u003cp\\u003eID + of a content view to show repositories in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003eID + of a content view version to show repositories in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"deb_id\",\"full_name\":\"deb_id\",\"description\":\"\\n\\u003cp\\u003eId + of a deb package to find repositories that contain the deb\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"erratum_id\",\"full_name\":\"erratum_id\",\"description\":\"\\n\\u003cp\\u003eId + of an erratum to find repositories that contain the erratum\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"rpm_id\",\"full_name\":\"rpm_id\",\"description\":\"\\n\\u003cp\\u003eId + of a rpm package to find repositories that contain the rpm\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"file_id\",\"full_name\":\"file_id\",\"description\":\"\\n\\u003cp\\u003eId + of a file to find repositories that contain the file\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_collection_id\",\"full_name\":\"ansible_collection_id\",\"description\":\"\\n\\u003cp\\u003eId + of an ansible collection to find repositories that contain the ansible collection\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"library\",\"full_name\":\"library\",\"description\":\"\\n\\u003cp\\u003eshow + repositories in Library and the default content view\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"archived\",\"full_name\":\"archived\",\"description\":\"\\n\\u003cp\\u003eshow + archived repositories\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003eLimit + the repository type. Available types endpoint: /katello/api/repositories/repository_types\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003ename + of the repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"label\",\"full_name\":\"label\",\"description\":\"\\n\\u003cp\\u003elabel + of the repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003edescription + of the repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"available_for\",\"full_name\":\"available_for\",\"description\":\"\\n\\u003cp\\u003einterpret + specified object to return only Repositories that can be associated with specified + object. Only \\u0026#39;content_view\\u0026#39; \\u0026amp; \\u0026#39;content_view_version\\u0026#39; + are supported.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"with_content\",\"full_name\":\"with_content\",\"description\":\"\\n\\u003cp\\u003eFilter + repositories by content unit type (erratum, docker_tag, etc.). Check the \u201CIndexed?\u201D + types here: /katello/api/repositories/repository_types\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"download_policy\",\"full_name\":\"download_policy\",\"description\":\"\\n\\u003cp\\u003elimit + to only repositories with this download policy\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eimmediate\\u003c/code\\u003e, \\u003ccode\\u003eon_demand\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"username\",\"full_name\":\"username\",\"description\":\"\\n\\u003cp\\u003eonly + show the repositories readable by this user with this username\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"container_repository_name\",\"type\":\"string\"},{\"name\":\"content_label\",\"type\":\"string\"},{\"name\":\"content_type\",\"type\":\"string\"},{\"name\":\"content_view_id\",\"type\":\"integer\"},{\"name\":\"description\",\"type\":\"text\"},{\"name\":\"distribution_arch\",\"type\":\"string\"},{\"name\":\"distribution_bootable\",\"type\":\"boolean\"},{\"name\":\"distribution_family\",\"type\":\"string\"},{\"name\":\"distribution_variant\",\"type\":\"string\"},{\"name\":\"distribution_version\",\"type\":\"string\"},{\"name\":\"download_policy\",\"type\":\"string\"},{\"name\":\"label\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"product\",\"type\":\"string\"},{\"name\":\"product_id\",\"type\":\"integer\"},{\"name\":\"product_name\",\"type\":\"string\"},{\"name\":\"redhat\",\"values\":[\"true\",\"false\"]}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/repositories/compare\",\"http_method\":\"GET\",\"short_description\":\"List + :resource\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/repositories\",\"http_method\":\"POST\",\"short_description\":\"Create + a custom repository\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the repository\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eDescription + of the repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"label\",\"full_name\":\"label\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_id\",\"full_name\":\"product_id\",\"description\":\"\\n\\u003cp\\u003eProduct + the repository belongs to\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003eType + of repository. Available types endpoint: /katello/api/repositories/repository_types\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"url\",\"description\":\"\\n\\u003cp\\u003erepository + source url\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"os_versions\",\"full_name\":\"os_versions\",\"description\":\"\\n\\u003cp\\u003eIdentifies + whether the repository should be unavailable on a client with a non-matching + OS version. Pass [] to make repo available for clients regardless of OS version. + Maximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8, rhel-9\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"gpg_key_id\",\"full_name\":\"gpg_key_id\",\"description\":\"\\n\\u003cp\\u003eid + of the gpg key that will be assigned to the new repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_ca_cert_id\",\"full_name\":\"ssl_ca_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL CA Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_cert_id\",\"full_name\":\"ssl_client_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL Client Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_key_id\",\"full_name\":\"ssl_client_key_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL Client Key\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"unprotected\",\"full_name\":\"unprotected\",\"description\":\"\\n\\u003cp\\u003etrue + if this repository can be published via HTTP\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"checksum_type\",\"full_name\":\"checksum_type\",\"description\":\"\\n\\u003cp\\u003eChecksum + of the repository, currently \\u0026#39;sha1\\u0026#39; \\u0026amp; \\u0026#39;sha256\\u0026#39; + are supported\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"docker_upstream_name\",\"full_name\":\"docker_upstream_name\",\"description\":\"\\n\\u003cp\\u003eName + of the upstream docker repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_tags\",\"full_name\":\"include_tags\",\"description\":\"\\n\\u003cp\\u003eComma-separated + list of tags to sync for a container image repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"exclude_tags\",\"full_name\":\"exclude_tags\",\"description\":\"\\n\\u003cp\\u003eComma-separated + list of tags to exclude when syncing a container image repository. Default: + any tag ending in \u201C-source\u201D\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"download_policy\",\"full_name\":\"download_policy\",\"description\":\"\\n\\u003cp\\u003edownload + policy for yum, deb, and docker repos (either \\u0026#39;immediate\\u0026#39; + or \\u0026#39;on_demand\\u0026#39;)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eimmediate\\u003c/code\\u003e, \\u003ccode\\u003eon_demand\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"download_concurrency\",\"full_name\":\"download_concurrency\",\"description\":\"\\n\\u003cp\\u003eUsed + to determine download concurrency of the repository in pulp3. Use value less + than 20. Defaults to 10\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mirroring_policy\",\"full_name\":\"mirroring_policy\",\"description\":\"\\n\\u003cp\\u003ePolicy + to set for mirroring content. Must be one of additive.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eadditive\\u003c/code\\u003e, \\u003ccode\\u003emirror_complete\\u003c/code\\u003e, + \\u003ccode\\u003emirror_content_only\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"verify_ssl_on_sync\",\"full_name\":\"verify_ssl_on_sync\",\"description\":\"\\n\\u003cp\\u003eif + true, Katello will verify the upstream url\\u0026#39;s SSL certifcates are + signed by a trusted CA\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_username\",\"full_name\":\"upstream_username\",\"description\":\"\\n\\u003cp\\u003eUsername + of the upstream repository user used for authentication\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_password\",\"full_name\":\"upstream_password\",\"description\":\"\\n\\u003cp\\u003ePassword + of the upstream repository user used for authentication\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_authentication_token\",\"full_name\":\"upstream_authentication_token\",\"description\":\"\\n\\u003cp\\u003ePassword + of the upstream authentication token.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"deb_releases\",\"full_name\":\"deb_releases\",\"description\":\"\\n\\u003cp\\u003ewhitespace-separated + list of releases to be synced from deb-archive\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"deb_components\",\"full_name\":\"deb_components\",\"description\":\"\\n\\u003cp\\u003ewhitespace-separated + list of repo components to be synced from deb-archive\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"deb_architectures\",\"full_name\":\"deb_architectures\",\"description\":\"\\n\\u003cp\\u003ewhitespace-separated + list of architectures to be synced from deb-archive\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ignorable_content\",\"full_name\":\"ignorable_content\",\"description\":\"\\n\\u003cp\\u003eList + of content units to ignore while syncing a yum repository. Must be subset + of srpm,treeinfo\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_collection_requirements\",\"full_name\":\"ansible_collection_requirements\",\"description\":\"\\n\\u003cp\\u003eContents + of requirement yaml file to sync from URL\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_collection_auth_url\",\"full_name\":\"ansible_collection_auth_url\",\"description\":\"\\n\\u003cp\\u003eThe + URL to receive a session token from, e.g. used with Automation Hub.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_collection_auth_token\",\"full_name\":\"ansible_collection_auth_token\",\"description\":\"\\n\\u003cp\\u003eThe + token key to use for authentication.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy_policy\",\"full_name\":\"http_proxy_policy\",\"description\":\"\\n\\u003cp\\u003epolicies + for HTTP Proxy for content sync\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eglobal_default_http_proxy\\u003c/code\\u003e, + \\u003ccode\\u003enone\\u003c/code\\u003e, \\u003ccode\\u003euse_selected_http_proxy\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy_id\",\"full_name\":\"http_proxy_id\",\"description\":\"\\n\\u003cp\\u003eID + of a HTTP Proxy\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"arch\",\"full_name\":\"arch\",\"description\":\"\\n\\u003cp\\u003eArchitecture + of content in the repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"retain_package_versions_count\",\"full_name\":\"retain_package_versions_count\",\"description\":\"\\n\\u003cp\\u003eThe + maximum number of versions of each package to keep.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"metadata_expire\",\"full_name\":\"metadata_expire\",\"description\":\"\\n\\u003cp\\u003eTime + to expire yum metadata in seconds. Only relevant for custom yum repositories.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"excludes\",\"full_name\":\"excludes\",\"description\":\"\\n\\u003cp\\u003ePython + packages to exclude from the upstream URL, names separated by newline. You + may also specify versions, for example: django~=2.0.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"includes\",\"full_name\":\"includes\",\"description\":\"\\n\\u003cp\\u003ePython + packages to include from the upstream URL, names separated by newline. You + may also specify versions, for example: django~=2.0. Leave empty to include + every package.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"package_types\",\"full_name\":\"package_types\",\"description\":\"\\n\\u003cp\\u003ePackage + types to sync for Python content, separated by comma. Leave empty to get every + package type. Package types are: bdist_dmg, bdist_dumb, bdist_egg, bdist_msi, + bdist_rpm, bdist_wheel, bdist_wininst, sdist.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/repository_types\",\"name\":\"repository_types\",\"apis\":[{\"api_url\":\"/katello/api/repositories/repository_types\",\"http_method\":\"GET\",\"short_description\":\"Show + the available repository types\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"creatable\",\"full_name\":\"creatable\",\"description\":\"\\n\\u003cp\\u003eWhen + set to \\u0026#39;True\\u0026#39; repository types that are creatable will + be returned\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/republish\",\"name\":\"republish\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:id/republish\",\"http_method\":\"PUT\",\"short_description\":\"Forces + a republish of the specified repository, regenerating metadata and symlinks + on the filesystem. Not allowed for repositories with the 'Complete Mirroring' + mirroring policy.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eRepository + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"force\",\"full_name\":\"force\",\"description\":\"\\n\\u003cp\\u003eForce + metadata regeneration to proceed. Dangerous when repositories use the \\u0026#39;Complete + Mirroring\\u0026#39; mirroring policy\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a repository\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003erepository + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/sync\",\"name\":\"sync\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:id/sync\",\"http_method\":\"POST\",\"short_description\":\"Sync + a repository\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003erepository + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"source_url\",\"full_name\":\"source_url\",\"description\":\"\\n\\u003cp\\u003etemporarily + override feed URL for sync\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"incremental\",\"full_name\":\"incremental\",\"description\":\"\\n\\u003cp\\u003eperform + an incremental import\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"skip_metadata_check\",\"full_name\":\"skip_metadata_check\",\"description\":\"\\n\\u003cp\\u003eForce + sync even if no upstream changes are detected. Only used with yum or deb repositories.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"validate_contents\",\"full_name\":\"validate_contents\",\"description\":\"\\n\\u003cp\\u003eForce + a sync and validate the checksums of all content. Only used with yum repositories.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/verify_checksum\",\"name\":\"verify_checksum\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:id/verify_checksum\",\"http_method\":\"POST\",\"short_description\":\"Verify + checksum of repository contents\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003erepository + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/reclaim_space\",\"name\":\"reclaim_space\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:id/reclaim_space\",\"http_method\":\"POST\",\"short_description\":\"Reclaim + space from an On Demand repository\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003erepository + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a repository\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003erepository + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003edescription + of the repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"url\",\"description\":\"\\n\\u003cp\\u003erepository + source url\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"os_versions\",\"full_name\":\"os_versions\",\"description\":\"\\n\\u003cp\\u003eIdentifies + whether the repository should be unavailable on a client with a non-matching + OS version. Pass [] to make repo available for clients regardless of OS version. + Maximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8, rhel-9\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"gpg_key_id\",\"full_name\":\"gpg_key_id\",\"description\":\"\\n\\u003cp\\u003eid + of the gpg key that will be assigned to the new repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_ca_cert_id\",\"full_name\":\"ssl_ca_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL CA Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_cert_id\",\"full_name\":\"ssl_client_cert_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL Client Cert\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_client_key_id\",\"full_name\":\"ssl_client_key_id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the content credential containing the SSL Client Key\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"unprotected\",\"full_name\":\"unprotected\",\"description\":\"\\n\\u003cp\\u003etrue + if this repository can be published via HTTP\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"checksum_type\",\"full_name\":\"checksum_type\",\"description\":\"\\n\\u003cp\\u003eChecksum + of the repository, currently \\u0026#39;sha1\\u0026#39; \\u0026amp; \\u0026#39;sha256\\u0026#39; + are supported\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"docker_upstream_name\",\"full_name\":\"docker_upstream_name\",\"description\":\"\\n\\u003cp\\u003eName + of the upstream docker repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"include_tags\",\"full_name\":\"include_tags\",\"description\":\"\\n\\u003cp\\u003eComma-separated + list of tags to sync for a container image repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"exclude_tags\",\"full_name\":\"exclude_tags\",\"description\":\"\\n\\u003cp\\u003eComma-separated + list of tags to exclude when syncing a container image repository. Default: + any tag ending in \u201C-source\u201D\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"download_policy\",\"full_name\":\"download_policy\",\"description\":\"\\n\\u003cp\\u003edownload + policy for yum, deb, and docker repos (either \\u0026#39;immediate\\u0026#39; + or \\u0026#39;on_demand\\u0026#39;)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eimmediate\\u003c/code\\u003e, \\u003ccode\\u003eon_demand\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"download_concurrency\",\"full_name\":\"download_concurrency\",\"description\":\"\\n\\u003cp\\u003eUsed + to determine download concurrency of the repository in pulp3. Use value less + than 20. Defaults to 10\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mirroring_policy\",\"full_name\":\"mirroring_policy\",\"description\":\"\\n\\u003cp\\u003ePolicy + to set for mirroring content. Must be one of additive.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eadditive\\u003c/code\\u003e, \\u003ccode\\u003emirror_complete\\u003c/code\\u003e, + \\u003ccode\\u003emirror_content_only\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"verify_ssl_on_sync\",\"full_name\":\"verify_ssl_on_sync\",\"description\":\"\\n\\u003cp\\u003eif + true, Katello will verify the upstream url\\u0026#39;s SSL certifcates are + signed by a trusted CA\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_username\",\"full_name\":\"upstream_username\",\"description\":\"\\n\\u003cp\\u003eUsername + of the upstream repository user used for authentication\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_password\",\"full_name\":\"upstream_password\",\"description\":\"\\n\\u003cp\\u003ePassword + of the upstream repository user used for authentication\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"upstream_authentication_token\",\"full_name\":\"upstream_authentication_token\",\"description\":\"\\n\\u003cp\\u003ePassword + of the upstream authentication token.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"deb_releases\",\"full_name\":\"deb_releases\",\"description\":\"\\n\\u003cp\\u003ewhitespace-separated + list of releases to be synced from deb-archive\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"deb_components\",\"full_name\":\"deb_components\",\"description\":\"\\n\\u003cp\\u003ewhitespace-separated + list of repo components to be synced from deb-archive\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"deb_architectures\",\"full_name\":\"deb_architectures\",\"description\":\"\\n\\u003cp\\u003ewhitespace-separated + list of architectures to be synced from deb-archive\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ignorable_content\",\"full_name\":\"ignorable_content\",\"description\":\"\\n\\u003cp\\u003eList + of content units to ignore while syncing a yum repository. Must be subset + of srpm,treeinfo\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_collection_requirements\",\"full_name\":\"ansible_collection_requirements\",\"description\":\"\\n\\u003cp\\u003eContents + of requirement yaml file to sync from URL\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_collection_auth_url\",\"full_name\":\"ansible_collection_auth_url\",\"description\":\"\\n\\u003cp\\u003eThe + URL to receive a session token from, e.g. used with Automation Hub.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ansible_collection_auth_token\",\"full_name\":\"ansible_collection_auth_token\",\"description\":\"\\n\\u003cp\\u003eThe + token key to use for authentication.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy_policy\",\"full_name\":\"http_proxy_policy\",\"description\":\"\\n\\u003cp\\u003epolicies + for HTTP Proxy for content sync\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eglobal_default_http_proxy\\u003c/code\\u003e, + \\u003ccode\\u003enone\\u003c/code\\u003e, \\u003ccode\\u003euse_selected_http_proxy\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy_id\",\"full_name\":\"http_proxy_id\",\"description\":\"\\n\\u003cp\\u003eID + of a HTTP Proxy\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"arch\",\"full_name\":\"arch\",\"description\":\"\\n\\u003cp\\u003eArchitecture + of content in the repository\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"retain_package_versions_count\",\"full_name\":\"retain_package_versions_count\",\"description\":\"\\n\\u003cp\\u003eThe + maximum number of versions of each package to keep.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"metadata_expire\",\"full_name\":\"metadata_expire\",\"description\":\"\\n\\u003cp\\u003eTime + to expire yum metadata in seconds. Only relevant for custom yum repositories.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"excludes\",\"full_name\":\"excludes\",\"description\":\"\\n\\u003cp\\u003ePython + packages to exclude from the upstream URL, names separated by newline. You + may also specify versions, for example: django~=2.0.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"includes\",\"full_name\":\"includes\",\"description\":\"\\n\\u003cp\\u003ePython + packages to include from the upstream URL, names separated by newline. You + may also specify versions, for example: django~=2.0. Leave empty to include + every package.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"package_types\",\"full_name\":\"package_types\",\"description\":\"\\n\\u003cp\\u003ePackage + types to sync for Python content, separated by comma. Leave empty to get every + package type. Package types are: bdist_dmg, bdist_dumb, bdist_egg, bdist_msi, + bdist_rpm, bdist_wheel, bdist_wininst, sdist.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Destroy + a custom repository\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"remove_from_content_view_versions\",\"full_name\":\"remove_from_content_view_versions\",\"description\":\"\\n\\u003cp\\u003eForce + delete the repository by removing it from all content view versions\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"delete_empty_repo_filters\",\"full_name\":\"delete_empty_repo_filters\",\"description\":\"\\n\\u003cp\\u003eDelete + content view filters that have this repository as the last associated repository. + Defaults to true. If false, such filters will now apply to all repositories + in the content view.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/remove_content\",\"name\":\"remove_content\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:id/remove_packages\",\"http_method\":\"PUT\",\"short_description\":null,\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:id/remove_docker_manifests\",\"http_method\":\"PUT\",\"short_description\":null,\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:id/remove_content\",\"http_method\":\"PUT\",\"short_description\":null,\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eRemove + content from a repository\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003erepository + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ids\",\"full_name\":\"ids\",\"description\":\"\\n\\u003cp\\u003eArray + of content ids to remove\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003eThe + type of content to remove (srpm, docker_manifest, etc.). Check removable types + here: /katello/api/repositories/repository_types\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sync_capsule\",\"full_name\":\"sync_capsule\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to sync an external capsule after upload. Default: true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/upload_content\",\"name\":\"upload_content\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:id/upload_content\",\"http_method\":\"POST\",\"short_description\":\"Upload + content into the repository\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003erepository + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content\",\"full_name\":\"content\",\"description\":\"\\n\\u003cp\\u003eContent + files to upload. Can be a single file or array of files.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"File\",\"expected_type\":\"file\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003eThe + type of content to upload (srpm, file, etc.). Check uploadable types here: + /katello/api/repositories/repository_types\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/import_uploads\",\"name\":\"import_uploads\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:id/import_uploads\",\"http_method\":\"PUT\",\"short_description\":\"Import + uploads into a repository\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eRepository + id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"async\",\"full_name\":\"async\",\"description\":\"\\n\\u003cp\\u003eDo + not wait for the ImportUpload action to finish. Default: false\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"publish_repository\",\"full_name\":\"publish_repository\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to regenerate the repository on disk. Default: true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sync_capsule\",\"full_name\":\"sync_capsule\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to sync an external capsule after upload. Default: true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_type\",\"full_name\":\"content_type\",\"description\":\"\\n\\u003cp\\u003econtent + type (\\u0026#39;deb\\u0026#39;, \\u0026#39;docker_manifest\\u0026#39;, \\u0026#39;file\\u0026#39;, + \\u0026#39;ostree_ref\\u0026#39;, \\u0026#39;rpm\\u0026#39;, \\u0026#39;srpm\\u0026#39;)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003edeb\\u003c/code\\u003e, \\u003ccode\\u003edocker_manifest\\u003c/code\\u003e, + \\u003ccode\\u003efile\\u003c/code\\u003e, \\u003ccode\\u003eostree_ref\\u003c/code\\u003e, + \\u003ccode\\u003epython_package\\u003c/code\\u003e, \\u003ccode\\u003erpm\\u003c/code\\u003e, + \\u003ccode\\u003esrpm\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"uploads\",\"full_name\":\"uploads\",\"description\":\"\\n\\u003cp\\u003eArray + of uploads to import\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"id\",\"full_name\":\"uploads[id]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_unit_id\",\"full_name\":\"uploads[content_unit_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"size\",\"full_name\":\"uploads[size]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"checksum\",\"full_name\":\"uploads[checksum]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"uploads[name]\",\"description\":\"\\n\\u003cp\\u003eNeeds + to only be set for file repositories or docker tags\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"digest\",\"full_name\":\"uploads[digest]\",\"description\":\"\\n\\u003cp\\u003eNeeds + to only be set for docker tags\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/gpg_key_content\",\"name\":\"gpg_key_content\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:id/gpg_key_content\",\"http_method\":\"GET\",\"short_description\":\"Return + the content of a repo gpg key, used directly by yum\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repositories/content_types\",\"name\":\"content_types\",\"apis\":[{\"api_url\":\"/katello/api/content_types\",\"http_method\":\"GET\",\"short_description\":\"Return + the enabled content types\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"repository_sets\":{\"doc_url\":\"/apidoc/v2/repository_sets\",\"id\":\"repository_sets\",\"api_url\":\"/api\",\"name\":\"Repository_sets\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/repository_sets/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/repository_sets\",\"http_method\":\"GET\",\"short_description\":\"List + repository sets.\",\"deprecated\":null},{\"api_url\":\"/katello/api/products/:product_id/repository_sets\",\"http_method\":\"GET\",\"short_description\":\"List + repository sets for a product.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"product_id\",\"full_name\":\"product_id\",\"description\":\"\\n\\u003cp\\u003eID + of a product to list repository sets from\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eRepository + set name to search on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"enabled\",\"description\":\"\\n\\u003cp\\u003eIf + true, only return repository sets that have been enabled. Defaults to false\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"with_active_subscription\",\"full_name\":\"with_active_subscription\",\"description\":\"\\n\\u003cp\\u003eIf + true, only return repository sets that are associated with an active subscriptions\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"with_custom\",\"full_name\":\"with_custom\",\"description\":\"\\n\\u003cp\\u003eIf + true, return custom repository sets along with redhat repos. Will be ignored + if repository_type is supplied.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"activation_key_id\",\"full_name\":\"activation_key_id\",\"description\":\"\\n\\u003cp\\u003eactivation + key identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eId + of the host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_access_mode_all\",\"full_name\":\"content_access_mode_all\",\"description\":\"\\n\\u003cp\\u003eGet + all content available, not just that provided by subscriptions.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_access_mode_env\",\"full_name\":\"content_access_mode_env\",\"description\":\"\\n\\u003cp\\u003eLimit + content to just that available in the host\\u0026#39;s or activation key\\u0026#39;s + content view version and lifecycle environment.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"status\",\"full_name\":\"status\",\"description\":\"\\n\\u003cp\\u003eLimit + content to enabled / disabled / overridden\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eenabled\\u003c/code\\u003e, \\u003ccode\\u003edisabled\\u003c/code\\u003e, + \\u003ccode\\u003eoverridden\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_type\",\"full_name\":\"repository_type\",\"description\":\"\\n\\u003cp\\u003eLimit + content to Red Hat / custom\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eredhat\\u003c/code\\u003e, \\u003ccode\\u003ecustom\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"content_label\",\"type\":\"string\"},{\"name\":\"content_type\",\"type\":\"string\"},{\"name\":\"enabled_by_default\",\"values\":[\"true\",\"false\"]},{\"name\":\"label\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"path\",\"type\":\"string\"},{\"name\":\"product\",\"type\":\"string\"},{\"name\":\"product_id\",\"type\":\"integer\"},{\"name\":\"product_name\",\"type\":\"string\"},{\"name\":\"redhat\",\"values\":[\"true\",\"false\"]}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repository_sets/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/repository_sets/:id\",\"http_method\":\"GET\",\"short_description\":\"Get + info about a repository set\",\"deprecated\":null},{\"api_url\":\"/katello/api/products/:product_id/repository_sets/:id\",\"http_method\":\"GET\",\"short_description\":\"Get + info about a repository set\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the repository set\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_id\",\"full_name\":\"product_id\",\"description\":\"\\n\\u003cp\\u003eID + of a product to list repository sets from\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repository_sets/available_repositories\",\"name\":\"available_repositories\",\"apis\":[{\"api_url\":\"/katello/api/repository_sets/:id/available_repositories\",\"http_method\":\"GET\",\"short_description\":\"Get + list of available repositories for the repository set\",\"deprecated\":null},{\"api_url\":\"/katello/api/products/:product_id/repository_sets/:id/available_repositories\",\"http_method\":\"GET\",\"short_description\":\"Get + list of available repositories for the repository set\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the repository set\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_id\",\"full_name\":\"product_id\",\"description\":\"\\n\\u003cp\\u003eID + of a product to list repository sets from\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repository_sets/enable\",\"name\":\"enable\",\"apis\":[{\"api_url\":\"/katello/api/repository_sets/:id/enable\",\"http_method\":\"PUT\",\"short_description\":\"Enable + a repository from the set\",\"deprecated\":null},{\"api_url\":\"/katello/api/products/:product_id/repository_sets/:id/enable\",\"http_method\":\"PUT\",\"short_description\":\"Enable + a repository from the set\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the repository set to enable\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_id\",\"full_name\":\"product_id\",\"description\":\"\\n\\u003cp\\u003eID + of the product containing the repository set\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"basearch\",\"full_name\":\"basearch\",\"description\":\"\\n\\u003cp\\u003eBasearch + to enable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"releasever\",\"full_name\":\"releasever\",\"description\":\"\\n\\u003cp\\u003eReleasever + to enable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/repository_sets/disable\",\"name\":\"disable\",\"apis\":[{\"api_url\":\"/katello/api/repository_sets/:id/disable\",\"http_method\":\"PUT\",\"short_description\":\"Disable + a repository from the set\",\"deprecated\":null},{\"api_url\":\"/katello/api/products/:product_id/repository_sets/:id/disable\",\"http_method\":\"PUT\",\"short_description\":\"Disable + a repository from the set\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the repository set to disable\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eID + of the repository within the set to disable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_id\",\"full_name\":\"product_id\",\"description\":\"\\n\\u003cp\\u003eID + of the product containing the repository set\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"basearch\",\"full_name\":\"basearch\",\"description\":\"\\n\\u003cp\\u003eBasearch + to disable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"releasever\",\"full_name\":\"releasever\",\"description\":\"\\n\\u003cp\\u003eReleasever + to disable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"simple_content_access\":{\"doc_url\":\"/apidoc/v2/simple_content_access\",\"id\":\"simple_content_access\",\"api_url\":\"/api\",\"name\":\"Simple_content_access\",\"short_description\":null,\"full_description\":\"\\n\\u003cp\\u003eRed + Hat subscriptions management platform.\\u003c/p\\u003e\\n\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/simple_content_access/eligible\",\"name\":\"eligible\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/simple_content_access/eligible\",\"http_method\":\"GET\",\"short_description\":\"Check + if the specified organization is eligible for Simple Content Access. WARNING: + Simple Content Access will be required for all organizations in Satellite + 6.16.\",\"deprecated\":true}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/simple_content_access/status\",\"name\":\"status\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/simple_content_access/status\",\"http_method\":\"GET\",\"short_description\":\"Check + if the specified organization has Simple Content Access enabled. WARNING: + Simple Content Access will be required for all organizations in Satellite + 6.16.\",\"deprecated\":true}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/simple_content_access/enable\",\"name\":\"enable\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/simple_content_access/enable\",\"http_method\":\"PUT\",\"short_description\":\"Enable + simple content access for a manifest\",\"deprecated\":true}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/simple_content_access/disable\",\"name\":\"disable\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/simple_content_access/disable\",\"http_method\":\"PUT\",\"short_description\":\"Disable + simple content access for a manifest. WARNING: Simple Content Access will + be required for all organizations in Satellite 6.16.\",\"deprecated\":true}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"srpms\":{\"doc_url\":\"/apidoc/v2/srpms\",\"id\":\"srpms\",\"api_url\":\"/api\",\"name\":\"Srpms\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/srpms/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/srpms\",\"http_method\":\"GET\",\"short_description\":\"List + srpms\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eRepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"environment_id\",\"description\":\"\\n\\u003cp\\u003eEnvironment + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content_view_version_id\",\"full_name\":\"content_view_version_id\",\"description\":\"\\n\\u003cp\\u003eContent + View Version identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/srpms/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/srpms/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + SRPM details\",\"deprecated\":null},{\"api_url\":\"/katello/api/repositories/:repository_id/srpms/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + SRPM details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003erepository + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eorganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eSRPM + details identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/srpms/compare\",\"name\":\"compare\",\"apis\":[{\"api_url\":\"/katello/api/srpms/compare\",\"http_method\":\"GET\",\"short_description\":\"List + srpms\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"content_view_version_ids\",\"full_name\":\"content_view_version_ids\",\"description\":\"\\n\\u003cp\\u003econtent + view versions to compare\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repository_id\",\"full_name\":\"repository_id\",\"description\":\"\\n\\u003cp\\u003eLibrary + repository id to restrict comparisons to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"restrict_comparison\",\"full_name\":\"restrict_comparison\",\"description\":\"\\n\\u003cp\\u003eReturn + same, different or all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"subscriptions\":{\"doc_url\":\"/apidoc/v2/subscriptions\",\"id\":\"subscriptions\",\"api_url\":\"/api\",\"name\":\"Subscriptions\",\"short_description\":null,\"full_description\":\"\\n\\u003cp\\u003eSubscriptions + management.\\u003c/p\\u003e\\n\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/subscriptions/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/subscriptions\",\"http_method\":\"GET\",\"short_description\":\"List + organization subscriptions\",\"deprecated\":null},{\"api_url\":\"/katello/api/activation_keys/:activation_key_id/subscriptions\",\"http_method\":\"GET\",\"short_description\":\"List + an activation key's subscriptions\",\"deprecated\":null},{\"api_url\":\"/katello/api/subscriptions\",\"http_method\":\"GET\",\"short_description\":\"List + subscriptions\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eid + of a host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"activation_key_id\",\"full_name\":\"activation_key_id\",\"description\":\"\\n\\u003cp\\u003eActivation + key ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003ename + of the subscription\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"available_for\",\"full_name\":\"available_for\",\"description\":\"\\n\\u003cp\\u003eObject + to show subscriptions available for, either \\u0026#39;host\\u0026#39; or + \\u0026#39;activation_key\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"match_host\",\"full_name\":\"match_host\",\"description\":\"\\n\\u003cp\\u003eIgnore + subscriptions that are unavailable to the specified host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"match_installed\",\"full_name\":\"match_installed\",\"description\":\"\\n\\u003cp\\u003eReturn + subscriptions that match installed products of the specified host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"no_overlap\",\"full_name\":\"no_overlap\",\"description\":\"\\n\\u003cp\\u003eReturn + subscriptions which do not overlap with a currently-attached subscription\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/subscriptions/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/subscriptions/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a subscription\",\"deprecated\":null},{\"api_url\":\"/katello/api/subscriptions/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a subscription\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eSubscription + identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/subscriptions/upload\",\"name\":\"upload\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/subscriptions/upload\",\"http_method\":\"POST\",\"short_description\":\"Upload + a subscription manifest\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"content\",\"full_name\":\"content\",\"description\":\"\\n\\u003cp\\u003eSubscription + manifest file\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"File\",\"expected_type\":\"file\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/subscriptions/refresh_manifest\",\"name\":\"refresh_manifest\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/subscriptions/refresh_manifest\",\"http_method\":\"PUT\",\"short_description\":\"Refresh + previously imported manifest for Red Hat provider\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/subscriptions/delete_manifest\",\"name\":\"delete_manifest\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/subscriptions/delete_manifest\",\"http_method\":\"POST\",\"short_description\":\"Delete + manifest from Red Hat provider\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + id\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/subscriptions/manifest_history\",\"name\":\"manifest_history\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/subscriptions/manifest_history\",\"http_method\":\"GET\",\"short_description\":\"obtain + manifest history for subscriptions\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"sync\":{\"doc_url\":\"/apidoc/v2/sync\",\"id\":\"sync\",\"api_url\":\"/api\",\"name\":\"Sync\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/sync/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/repositories/:repository_id/sync\",\"http_method\":\"GET\",\"short_description\":\"Get + status of synchronisation for given repository\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"sync_plans\":{\"doc_url\":\"/apidoc/v2/sync_plans\",\"id\":\"sync_plans\",\"api_url\":\"/api\",\"name\":\"Sync_plans\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/sync_plans/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/sync_plans\",\"http_method\":\"GET\",\"short_description\":\"List + sync plans\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/sync_plans\",\"http_method\":\"GET\",\"short_description\":null,\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003efilter + by name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sync_date\",\"full_name\":\"sync_date\",\"description\":\"\\n\\u003cp\\u003efilter + by sync date\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interval\",\"full_name\":\"interval\",\"description\":\"\\n\\u003cp\\u003efilter + by interval\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ehourly\\u003c/code\\u003e, \\u003ccode\\u003edaily\\u003c/code\\u003e, + \\u003ccode\\u003eweekly\\u003c/code\\u003e, \\u003ccode\\u003ecustom cron\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003eSearch + string\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + field and order, eg. \\u0026#39;id DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full_result\",\"full_name\":\"full_result\",\"description\":\"\\n\\u003cp\\u003eWhether + or not to show all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eField + to sort the results on\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_order\",\"full_name\":\"sort_order\",\"description\":\"\\n\\u003cp\\u003eHow + to order the sorted results (e.g. ASC for ascending)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"enabled\",\"values\":[\"true\",\"false\"]},{\"name\":\"interval\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/sync_plans/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/sync_plans/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a sync plan\",\"deprecated\":null},{\"api_url\":\"/katello/api/sync_plans/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a sync plan\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003esync + plan numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/sync_plans/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/sync_plans\",\"http_method\":\"POST\",\"short_description\":\"Create + a sync plan\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003esync + plan name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interval\",\"full_name\":\"interval\",\"description\":\"\\n\\u003cp\\u003ehow + often synchronization should run\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ehourly\\u003c/code\\u003e, \\u003ccode\\u003edaily\\u003c/code\\u003e, + \\u003ccode\\u003eweekly\\u003c/code\\u003e, \\u003ccode\\u003ecustom cron\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sync_date\",\"full_name\":\"sync_date\",\"description\":\"\\n\\u003cp\\u003estart + datetime of synchronization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003esync + plan description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"enabled\",\"description\":\"\\n\\u003cp\\u003eenables + or disables synchronization\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cron_expression\",\"full_name\":\"cron_expression\",\"description\":\"\\n\\u003cp\\u003eAdd + custom cron logic for sync plan\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/sync_plans/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/sync_plans/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a sync plan\",\"deprecated\":null},{\"api_url\":\"/katello/api/sync_plans/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a sync plan\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003esync + plan numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003esync + plan name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interval\",\"full_name\":\"interval\",\"description\":\"\\n\\u003cp\\u003ehow + often synchronization should run\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ehourly\\u003c/code\\u003e, \\u003ccode\\u003edaily\\u003c/code\\u003e, + \\u003ccode\\u003eweekly\\u003c/code\\u003e, \\u003ccode\\u003ecustom cron\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sync_date\",\"full_name\":\"sync_date\",\"description\":\"\\n\\u003cp\\u003estart + datetime of synchronization\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003esync + plan description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"enabled\",\"description\":\"\\n\\u003cp\\u003eenables + or disables synchronization\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cron_expression\",\"full_name\":\"cron_expression\",\"description\":\"\\n\\u003cp\\u003eAdd + custom cron logic for sync plan\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/sync_plans/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/sync_plans/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Destroy + a sync plan\",\"deprecated\":null},{\"api_url\":\"/katello/api/sync_plans/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Destroy + a sync plan\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003esync + plan numeric identifier\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/sync_plans/add_products\",\"name\":\"add_products\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/sync_plans/:id/add_products\",\"http_method\":\"PUT\",\"short_description\":\"Add + products to sync plan\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the sync plan\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_ids\",\"full_name\":\"product_ids\",\"description\":\"\\n\\u003cp\\u003eList + of product ids to add to the sync plan\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/sync_plans/remove_products\",\"name\":\"remove_products\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/sync_plans/:id/remove_products\",\"http_method\":\"PUT\",\"short_description\":\"Remove + products from sync plan\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the sync plan\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"product_ids\",\"full_name\":\"product_ids\",\"description\":\"\\n\\u003cp\\u003eList + of product ids to remove from the sync plan\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/sync_plans/sync\",\"name\":\"sync\",\"apis\":[{\"api_url\":\"/katello/api/sync_plans/:id/sync\",\"http_method\":\"PUT\",\"short_description\":\"Initiate + a sync of the products attached to the sync plan\",\"deprecated\":null},{\"api_url\":\"/katello/api/organizations/:organization_id/sync_plans/:id/sync\",\"http_method\":\"PUT\",\"short_description\":\"Initiate + a sync of the products attached to the sync plan\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of the sync plan\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"upstream_subscriptions\":{\"doc_url\":\"/apidoc/v2/upstream_subscriptions\",\"id\":\"upstream_subscriptions\",\"api_url\":\"/api\",\"name\":\"Upstream_subscriptions\",\"short_description\":null,\"full_description\":\"\\n\\u003cp\\u003eRed + Hat subscriptions management platform.\\u003c/p\\u003e\\n\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/upstream_subscriptions/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/upstream_subscriptions\",\"http_method\":\"GET\",\"short_description\":\"List + available subscriptions from Red Hat Subscription Management\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eThe + order to sort the results in. [\\u0026#39;asc\\u0026#39;, \\u0026#39;desc\\u0026#39;] + Defaults to \\u0026#39;desc\\u0026#39;.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sort_by\",\"full_name\":\"sort_by\",\"description\":\"\\n\\u003cp\\u003eThe + field to sort the data by. Defaults to the created date.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"pool_ids\",\"full_name\":\"pool_ids\",\"description\":\"\\n\\u003cp\\u003eReturn + only the upstream pools which map to the given Katello pool IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"quantities_only\",\"full_name\":\"quantities_only\",\"description\":\"\\n\\u003cp\\u003eOnly + returns id and quantity fields\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attachable\",\"full_name\":\"attachable\",\"description\":\"\\n\\u003cp\\u003eReturn + only subscriptions which can be attached to the upstream allocation\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/upstream_subscriptions/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/upstream_subscriptions\",\"http_method\":\"PUT\",\"short_description\":\"Update + the quantity of one or more subscriptions on an upstream allocation\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"pools\",\"full_name\":\"pools\",\"description\":\"\\n\\u003cp\\u003eArray + of Pools to be updated. Only pools originating upstream are accepted.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"id\",\"full_name\":\"pools[id]\",\"description\":\"\\n\\u003cp\\u003eKatello + ID of local pool to update\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"quantity\",\"full_name\":\"pools[quantity]\",\"description\":\"\\n\\u003cp\\u003eDesired + quantity of the pool\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/upstream_subscriptions/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/upstream_subscriptions\",\"http_method\":\"DELETE\",\"short_description\":\"Remove + one or more subscriptions from an upstream manifest\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"pool_ids\",\"full_name\":\"pool_ids\",\"description\":\"\\n\\u003cp\\u003eArray + of local pool IDs. Only pools originating upstream are accepted.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/upstream_subscriptions/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/upstream_subscriptions\",\"http_method\":\"POST\",\"short_description\":\"Add + subscriptions consumed by a manifest from Red Hat Subscription Management\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"pools\",\"full_name\":\"pools\",\"description\":\"\\n\\u003cp\\u003eArray + of pools to add\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"id\",\"full_name\":\"pools[id]\",\"description\":\"\\n\\u003cp\\u003eCandlepin + ID of pool to add\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"quantity\",\"full_name\":\"pools[quantity]\",\"description\":\"\\n\\u003cp\\u003eQuantity + of entitlements to bind\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eOrganization + ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/upstream_subscriptions/ping\",\"name\":\"ping\",\"apis\":[{\"api_url\":\"/katello/api/organizations/:organization_id/upstream_subscriptions/ping\",\"http_method\":\"GET\",\"short_description\":\"Check + if a connection can be made to Red Hat Subscription Management.\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"configs\":{\"doc_url\":\"/apidoc/v2/configs\",\"id\":\"configs\",\"api_url\":\"/api\",\"name\":\"Configs\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/configs/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/foreman_virt_who_configure/api/v2/configs\",\"http_method\":\"GET\",\"short_description\":\"List + of virt-who configurations\",\"deprecated\":null},{\"api_url\":\"/foreman_virt_who_configure/api/v2/organizations/:organization_id/configs\",\"http_method\":\"GET\",\"short_description\":\"List + of virt-who configurations per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/configs/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/foreman_virt_who_configure/api/v2/configs/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a virt-who configuration\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/configs/deploy_script\",\"name\":\"deploy_script\",\"apis\":[{\"api_url\":\"/foreman_virt_who_configure/api/v2/configs/:id/deploy_script\",\"http_method\":\"GET\",\"short_description\":\"Renders + a deploy script for the specified virt-who configuration\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/configs/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/foreman_virt_who_configure/api/v2/configs\",\"http_method\":\"POST\",\"short_description\":\"Create + a virt-who configuration\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"foreman_virt_who_configure_config\",\"full_name\":\"foreman_virt_who_configure_config\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"foreman_virt_who_configure_config[name]\",\"description\":\"\\n\\u003cp\\u003eConfiguration + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interval\",\"full_name\":\"foreman_virt_who_configure_config[interval]\",\"description\":\"\\n\\u003cp\\u003eConfiguration + interval in minutes\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003e60\\u003c/code\\u003e, \\u003ccode\\u003e120\\u003c/code\\u003e, + \\u003ccode\\u003e240\\u003c/code\\u003e, \\u003ccode\\u003e480\\u003c/code\\u003e, + \\u003ccode\\u003e720\\u003c/code\\u003e, \\u003ccode\\u003e1440\\u003c/code\\u003e, + \\u003ccode\\u003e2880\\u003c/code\\u003e, \\u003ccode\\u003e4320\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"filtering_mode\",\"full_name\":\"foreman_virt_who_configure_config[filtering_mode]\",\"description\":\"\\n\\u003cp\\u003eHypervisor + filtering mode, 0 means no filtering, 1 means whitelist, 2 means blacklist\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003e0\\u003c/code\\u003e, \\u003ccode\\u003e1\\u003c/code\\u003e, + \\u003ccode\\u003e2\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"whitelist\",\"full_name\":\"foreman_virt_who_configure_config[whitelist]\",\"description\":\"\\n\\u003cp\\u003eHypervisor + whitelist, applicable only when filtering mode is set to 1. Wildcards and + regular expressions are supported, multiple records must be separated by comma.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"blacklist\",\"full_name\":\"foreman_virt_who_configure_config[blacklist]\",\"description\":\"\\n\\u003cp\\u003eHypervisor + blacklist, applicable only when filtering mode is set to 2. Wildcards and + regular expressions are supported, multiple records must be separated by comma.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"filter_host_parents\",\"full_name\":\"foreman_virt_who_configure_config[filter_host_parents]\",\"description\":\"\\n\\u003cp\\u003eApplicable + only for esx provider type. Only hosts which parent (usually ComputeResource) + name is specified in comma-separated list in this option will be reported. + Wildcards and regular expressions are supported, multiple records must be + separated by comma. Put the value into the double-quotes if it contains special + characters like comma. All new line characters will be removed in resulting + configuration file, white spaces are removed from beginning and end.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"exclude_host_parents\",\"full_name\":\"foreman_virt_who_configure_config[exclude_host_parents]\",\"description\":\"\\n\\u003cp\\u003eApplicable + only for esx provider type. Hosts which parent (usually ComputeResource) name + is specified in comma-separated list in this option will \\u003cstrong\\u003eNOT\\u003c/strong\\u003e + be reported. Wildcards and regular expressions are supported, multiple records + must be separated by comma. Put the value into the double-quotes if it contains + special characters like comma. All new line characters will be removed in + resulting configuration file, white spaces are removed from beginning and + end.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_id\",\"full_name\":\"foreman_virt_who_configure_config[hypervisor_id]\",\"description\":\"\\n\\u003cp\\u003eSpecifies + how the hypervisor will be identified.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ehostname\\u003c/code\\u003e, \\u003ccode\\u003euuid\\u003c/code\\u003e, + \\u003ccode\\u003ehwuuid\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_type\",\"full_name\":\"foreman_virt_who_configure_config[hypervisor_type]\",\"description\":\"\\n\\u003cp\\u003eHypervisor + type\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eesx\\u003c/code\\u003e, \\u003ccode\\u003ehyperv\\u003c/code\\u003e, + \\u003ccode\\u003elibvirt\\u003c/code\\u003e, \\u003ccode\\u003ekubevirt\\u003c/code\\u003e, + \\u003ccode\\u003eahv\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_server\",\"full_name\":\"foreman_virt_who_configure_config[hypervisor_server]\",\"description\":\"\\n\\u003cp\\u003eFully + qualified host name or IP address of the hypervisor\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_username\",\"full_name\":\"foreman_virt_who_configure_config[hypervisor_username]\",\"description\":\"\\n\\u003cp\\u003eAccount + name by which virt-who is to connect to the hypervisor.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_password\",\"full_name\":\"foreman_virt_who_configure_config[hypervisor_password]\",\"description\":\"\\n\\u003cp\\u003eHypervisor + password, required for all hypervisor types except for libvirt/kubevirt.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"satellite_url\",\"full_name\":\"foreman_virt_who_configure_config[satellite_url]\",\"description\":\"\\n\\u003cp\\u003eSatellite + server FQDN\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"debug\",\"full_name\":\"foreman_virt_who_configure_config[debug]\",\"description\":\"\\n\\u003cp\\u003eEnable + debugging output\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"kubeconfig_path\",\"full_name\":\"foreman_virt_who_configure_config[kubeconfig_path]\",\"description\":\"\\n\\u003cp\\u003eConfiguration + file containing details about how to connect to the cluster and authentication + details.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy_id\",\"full_name\":\"foreman_virt_who_configure_config[http_proxy_id]\",\"description\":\"\\n\\u003cp\\u003eHTTP + Proxy that should be used for communication between the server on which virt-who + is running and the hypervisors and virtualization managers.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"no_proxy\",\"full_name\":\"foreman_virt_who_configure_config[no_proxy]\",\"description\":\"\\n\\u003cp\\u003eIgnore + Proxy. A comma-separated list of hostnames or domains or ip addresses to ignore + Capsule settings for. Optionally this may be set to * to bypass proxy settings + for all hostnames domains or ip addresses.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"foreman_virt_who_configure_config[organization_id]\",\"description\":\"\\n\\u003cp\\u003eOrganization + of the virt-who configuration\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"prism_flavor\",\"full_name\":\"foreman_virt_who_configure_config[prism_flavor]\",\"description\":\"\\n\\u003cp\\u003eSelect + the Prism flavor you are connecting to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ecentral\\u003c/code\\u003e, \\u003ccode\\u003eelement\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ahv_internal_debug\",\"full_name\":\"foreman_virt_who_configure_config[ahv_internal_debug]\",\"description\":\"\\n\\u003cp\\u003eOption + Enable debugging output is required to enable AHV internal debug. It provides + extra AHV debug information when both options are enabled\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/configs/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/foreman_virt_who_configure/api/v2/configs/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a virt-who configuration\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eConfiguration + numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"foreman_virt_who_configure_config\",\"full_name\":\"foreman_virt_who_configure_config\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"foreman_virt_who_configure_config[name]\",\"description\":\"\\n\\u003cp\\u003eConfiguration + name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interval\",\"full_name\":\"foreman_virt_who_configure_config[interval]\",\"description\":\"\\n\\u003cp\\u003eConfiguration + interval in minutes\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003e60\\u003c/code\\u003e, \\u003ccode\\u003e120\\u003c/code\\u003e, + \\u003ccode\\u003e240\\u003c/code\\u003e, \\u003ccode\\u003e480\\u003c/code\\u003e, + \\u003ccode\\u003e720\\u003c/code\\u003e, \\u003ccode\\u003e1440\\u003c/code\\u003e, + \\u003ccode\\u003e2880\\u003c/code\\u003e, \\u003ccode\\u003e4320\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"filtering_mode\",\"full_name\":\"foreman_virt_who_configure_config[filtering_mode]\",\"description\":\"\\n\\u003cp\\u003eHypervisor + filtering mode, 0 means no filtering, 1 means whitelist, 2 means blacklist\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003e0\\u003c/code\\u003e, \\u003ccode\\u003e1\\u003c/code\\u003e, + \\u003ccode\\u003e2\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"whitelist\",\"full_name\":\"foreman_virt_who_configure_config[whitelist]\",\"description\":\"\\n\\u003cp\\u003eHypervisor + whitelist, applicable only when filtering mode is set to 1. Wildcards and + regular expressions are supported, multiple records must be separated by comma.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"blacklist\",\"full_name\":\"foreman_virt_who_configure_config[blacklist]\",\"description\":\"\\n\\u003cp\\u003eHypervisor + blacklist, applicable only when filtering mode is set to 2. Wildcards and + regular expressions are supported, multiple records must be separated by comma.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"filter_host_parents\",\"full_name\":\"foreman_virt_who_configure_config[filter_host_parents]\",\"description\":\"\\n\\u003cp\\u003eApplicable + only for esx provider type. Only hosts which parent (usually ComputeResource) + name is specified in comma-separated list in this option will be reported. + Wildcards and regular expressions are supported, multiple records must be + separated by comma. Put the value into the double-quotes if it contains special + characters like comma. All new line characters will be removed in resulting + configuration file, white spaces are removed from beginning and end.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"exclude_host_parents\",\"full_name\":\"foreman_virt_who_configure_config[exclude_host_parents]\",\"description\":\"\\n\\u003cp\\u003eApplicable + only for esx provider type. Hosts which parent (usually ComputeResource) name + is specified in comma-separated list in this option will \\u003cstrong\\u003eNOT\\u003c/strong\\u003e + be reported. Wildcards and regular expressions are supported, multiple records + must be separated by comma. Put the value into the double-quotes if it contains + special characters like comma. All new line characters will be removed in + resulting configuration file, white spaces are removed from beginning and + end.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_id\",\"full_name\":\"foreman_virt_who_configure_config[hypervisor_id]\",\"description\":\"\\n\\u003cp\\u003eSpecifies + how the hypervisor will be identified.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ehostname\\u003c/code\\u003e, \\u003ccode\\u003euuid\\u003c/code\\u003e, + \\u003ccode\\u003ehwuuid\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_type\",\"full_name\":\"foreman_virt_who_configure_config[hypervisor_type]\",\"description\":\"\\n\\u003cp\\u003eHypervisor + type\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eesx\\u003c/code\\u003e, \\u003ccode\\u003ehyperv\\u003c/code\\u003e, + \\u003ccode\\u003elibvirt\\u003c/code\\u003e, \\u003ccode\\u003ekubevirt\\u003c/code\\u003e, + \\u003ccode\\u003eahv\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_server\",\"full_name\":\"foreman_virt_who_configure_config[hypervisor_server]\",\"description\":\"\\n\\u003cp\\u003eFully + qualified host name or IP address of the hypervisor\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_username\",\"full_name\":\"foreman_virt_who_configure_config[hypervisor_username]\",\"description\":\"\\n\\u003cp\\u003eAccount + name by which virt-who is to connect to the hypervisor.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hypervisor_password\",\"full_name\":\"foreman_virt_who_configure_config[hypervisor_password]\",\"description\":\"\\n\\u003cp\\u003eHypervisor + password, required for all hypervisor types except for libvirt/kubevirt.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"satellite_url\",\"full_name\":\"foreman_virt_who_configure_config[satellite_url]\",\"description\":\"\\n\\u003cp\\u003eSatellite + server FQDN\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"debug\",\"full_name\":\"foreman_virt_who_configure_config[debug]\",\"description\":\"\\n\\u003cp\\u003eEnable + debugging output\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"kubeconfig_path\",\"full_name\":\"foreman_virt_who_configure_config[kubeconfig_path]\",\"description\":\"\\n\\u003cp\\u003eConfiguration + file containing details about how to connect to the cluster and authentication + details.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy_id\",\"full_name\":\"foreman_virt_who_configure_config[http_proxy_id]\",\"description\":\"\\n\\u003cp\\u003eHTTP + Proxy that should be used for communication between the server on which virt-who + is running and the hypervisors and virtualization managers.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"no_proxy\",\"full_name\":\"foreman_virt_who_configure_config[no_proxy]\",\"description\":\"\\n\\u003cp\\u003eIgnore + Proxy. A comma-separated list of hostnames or domains or ip addresses to ignore + Capsule settings for. Optionally this may be set to * to bypass proxy settings + for all hostnames domains or ip addresses.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"foreman_virt_who_configure_config[organization_id]\",\"description\":\"\\n\\u003cp\\u003eOrganization + of the virt-who configuration\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"prism_flavor\",\"full_name\":\"foreman_virt_who_configure_config[prism_flavor]\",\"description\":\"\\n\\u003cp\\u003eSelect + the Prism flavor you are connecting to\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ecentral\\u003c/code\\u003e, \\u003ccode\\u003eelement\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ahv_internal_debug\",\"full_name\":\"foreman_virt_who_configure_config[ahv_internal_debug]\",\"description\":\"\\n\\u003cp\\u003eOption + Enable debugging output is required to enable AHV internal debug. It provides + extra AHV debug information when both options are enabled\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/configs/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/foreman_virt_who_configure/api/v2/configs/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a virt-who configuration\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eConfiguration + numeric identifier\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"discovered_hosts\":{\"doc_url\":\"/apidoc/v2/discovered_hosts\",\"id\":\"discovered_hosts\",\"api_url\":\"/api\",\"name\":\"Discovered_hosts\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/discovered_hosts/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/v2/discovered_hosts\",\"http_method\":\"GET\",\"short_description\":\"List + all discovered hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003esort + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003epaginate + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003enumber + of entries per request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovered_hosts/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/v2/discovered_hosts/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a discovered host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovered_hosts/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/v2/discovered_hosts\",\"http_method\":\"POST\",\"short_description\":\"Create + a discovered host for testing (use /facts to create new hosts)\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"discovered_host\",\"full_name\":\"discovered_host\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"discovered_host[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip\",\"full_name\":\"discovered_host[ip]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mac\",\"full_name\":\"discovered_host[mac]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"pxe_loader\",\"full_name\":\"discovered_host[pxe_loader]\",\"description\":\"\\n\\u003cp\\u003eDHCP + filename option (Grub2 or PXELinux by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eNone\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux + BIOS\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub UEFI\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 BIOS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 ELF\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 + UEFI HTTP\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI HTTPS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI HTTPS SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Embedded\\u003c/code\\u003e, \\u003ccode\\u003eiPXE UEFI HTTP\\u003c/code\\u003e, + \\u003ccode\\u003eiPXE Chain BIOS\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Chain UEFI\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovered_hosts/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/v2/discovered_hosts/:id\",\"http_method\":\"PUT\",\"short_description\":\"Provision + a discovered host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"discovered_host\",\"full_name\":\"discovered_host\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"discovered_host[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_id\",\"full_name\":\"discovered_host[environment_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ip\",\"full_name\":\"discovered_host[ip]\",\"description\":\"\\n\\u003cp\\u003enot + required if using a subnet with DHCP Capsule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mac\",\"full_name\":\"discovered_host[mac]\",\"description\":\"\\n\\u003cp\\u003enot + required if it\\u0026#39;s a virtual machine\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_id\",\"full_name\":\"discovered_host[architecture_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"discovered_host[domain_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"puppet_proxy_id\",\"full_name\":\"discovered_host[puppet_proxy_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"puppet_class_ids\",\"full_name\":\"discovered_host[puppet_class_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"discovered_host[operatingsystem_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_id\",\"full_name\":\"discovered_host[medium_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if not imaged based provisioning and host is managed and value is not inherited + from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_id\",\"full_name\":\"discovered_host[ptable_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and custom partition has not been defined\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"discovered_host[subnet_id]\",\"description\":\"\\n\\u003cp\\u003erequired + if host is managed and value is not inherited from host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"sp_subnet_id\",\"full_name\":\"discovered_host[sp_subnet_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"model_id\",\"full_name\":\"discovered_host[model_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"discovered_host[hostgroup_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"owner_id\",\"full_name\":\"discovered_host[owner_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"owner_type\",\"full_name\":\"discovered_host[owner_type]\",\"description\":\"\\n\\u003cp\\u003eHost\\u0026#39;s + owner type\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eUser\\u003c/code\\u003e, \\u003ccode\\u003eUsergroup\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"puppet_ca_proxy_id\",\"full_name\":\"discovered_host[puppet_ca_proxy_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"image_id\",\"full_name\":\"discovered_host[image_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_parameters_attributes\",\"full_name\":\"discovered_host[host_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eHost\\u0026#39;s + parameters (array or indexed hash)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"discovered_host[host_parameters_attributes][name]\",\"description\":\"\\n\\u003cp\\u003eName + of the parameter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"discovered_host[host_parameters_attributes][value]\",\"description\":\"\\n\\u003cp\\u003eParameter + value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter_type\",\"full_name\":\"discovered_host[host_parameters_attributes][parameter_type]\",\"description\":\"\\n\\u003cp\\u003eType + of value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"discovered_host[host_parameters_attributes][hidden_value]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"build\",\"full_name\":\"discovered_host[build]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"discovered_host[enabled]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provision_method\",\"full_name\":\"discovered_host[provision_method]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"managed\",\"full_name\":\"discovered_host[managed]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"progress_report_id\",\"full_name\":\"discovered_host[progress_report_id]\",\"description\":\"\\n\\u003cp\\u003eUUID + to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"capabilities\",\"full_name\":\"discovered_host[capabilities]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"root_pass\",\"full_name\":\"discovered_host[root_pass]\",\"description\":\"\\n\\u003cp\\u003erequired + if value is not inherited from host group or default password in settings\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"pxe_loader\",\"full_name\":\"discovered_host[pxe_loader]\",\"description\":\"\\n\\u003cp\\u003eDHCP + filename option (Grub2 or PXELinux by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eNone\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux + BIOS\\u003c/code\\u003e, \\u003ccode\\u003ePXELinux UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub UEFI\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 BIOS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 ELF\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 + UEFI HTTP\\u003c/code\\u003e, \\u003ccode\\u003eGrub2 UEFI HTTPS\\u003c/code\\u003e, + \\u003ccode\\u003eGrub2 UEFI HTTPS SecureBoot\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Embedded\\u003c/code\\u003e, \\u003ccode\\u003eiPXE UEFI HTTP\\u003c/code\\u003e, + \\u003ccode\\u003eiPXE Chain BIOS\\u003c/code\\u003e, \\u003ccode\\u003eiPXE + Chain UEFI\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovered_hosts/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/v2/discovered_hosts/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a discovered host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovered_hosts/facts\",\"name\":\"facts\",\"apis\":[{\"api_url\":\"/api/v2/discovered_hosts/facts\",\"http_method\":\"POST\",\"short_description\":\"Upload + facts for a host, creating the host if required\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"facts\",\"full_name\":\"facts\",\"description\":\"\\n\\u003cp\\u003ehash + containing facts for the host with minimum set of facts: discovery_bootif, + macaddress_eth0, ipaddress, ipaddress_eth0, interfaces: eth0 (example in case + primary interface is named eth0)\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovered_hosts/auto_provision\",\"name\":\"auto_provision\",\"apis\":[{\"api_url\":\"/api/v2/discovered_hosts/:id/auto_provision\",\"http_method\":\"POST\",\"short_description\":\"Execute + rules against a discovered host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovered_hosts/auto_provision_all\",\"name\":\"auto_provision_all\",\"apis\":[{\"api_url\":\"/api/v2/discovered_hosts/auto_provision_all\",\"http_method\":\"POST\",\"short_description\":\"Execute + rules against all currently discovered hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovered_hosts/refresh_facts\",\"name\":\"refresh_facts\",\"apis\":[{\"api_url\":\"/api/v2/discovered_hosts/:id/refresh_facts\",\"http_method\":\"PUT\",\"short_description\":\"Refreshing + the facts of a discovered host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovered_hosts/reboot\",\"name\":\"reboot\",\"apis\":[{\"api_url\":\"/api/v2/discovered_hosts/:id/reboot\",\"http_method\":\"PUT\",\"short_description\":\"Rebooting + a discovered host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovered_hosts/reboot_all\",\"name\":\"reboot_all\",\"apis\":[{\"api_url\":\"/api/v2/discovered_hosts/reboot_all\",\"http_method\":\"PUT\",\"short_description\":\"Rebooting + all discovered hosts\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"discovery_rules\":{\"doc_url\":\"/apidoc/v2/discovery_rules\",\"id\":\"discovery_rules\",\"api_url\":\"/api\",\"name\":\"Discovery_rules\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/discovery_rules/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/v2/discovery_rules\",\"http_method\":\"GET\",\"short_description\":\"List + all discovery rules\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003esort + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003epaginate + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003enumber + of entries per request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovery_rules/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/v2/discovery_rules/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a discovery rule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovery_rules/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/v2/discovery_rules\",\"http_method\":\"POST\",\"short_description\":\"Create + a discovery rule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"discovery_rule\",\"full_name\":\"discovery_rule\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"discovery_rule[name]\",\"description\":\"\\n\\u003cp\\u003erepresents + rule name shown to the users\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"discovery_rule[search]\",\"description\":\"\\n\\u003cp\\u003equery + to match discovered hosts for the particular rule\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"discovery_rule[hostgroup_id]\",\"description\":\"\\n\\u003cp\\u003ethe + hostgroup that is used to auto provision a host\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostname\",\"full_name\":\"discovery_rule[hostname]\",\"description\":\"\\n\\u003cp\\u003edefines + a pattern to assign human-readable hostnames to the matching hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"max_count\",\"full_name\":\"discovery_rule[max_count]\",\"description\":\"\\n\\u003cp\\u003eenables + to limit maximum amount of provisioned hosts per rule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"priority\",\"full_name\":\"discovery_rule[priority]\",\"description\":\"\\n\\u003cp\\u003eputs + the rules in order, low numbers go first. Must be greater then zero\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"discovery_rule[enabled]\",\"description\":\"\\n\\u003cp\\u003eflag + is used for temporary shutdown of rules\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"discovery_rule[location_ids]\",\"description\":\"\\n\\u003cp\\u003elocation + ID for provisioned hosts\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"discovery_rule[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eorganization + ID for provisioned hosts\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovery_rules/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/v2/discovery_rules/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a rule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"discovery_rule\",\"full_name\":\"discovery_rule\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"discovery_rule[name]\",\"description\":\"\\n\\u003cp\\u003erepresents + rule name shown to the users\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"discovery_rule[search]\",\"description\":\"\\n\\u003cp\\u003equery + to match discovered hosts for the particular rule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"discovery_rule[hostgroup_id]\",\"description\":\"\\n\\u003cp\\u003ethe + hostgroup that is used to auto provision a host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostname\",\"full_name\":\"discovery_rule[hostname]\",\"description\":\"\\n\\u003cp\\u003edefines + a pattern to assign human-readable hostnames to the matching hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"max_count\",\"full_name\":\"discovery_rule[max_count]\",\"description\":\"\\n\\u003cp\\u003eenables + to limit maximum amount of provisioned hosts per rule\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"priority\",\"full_name\":\"discovery_rule[priority]\",\"description\":\"\\n\\u003cp\\u003eputs + the rules in order, low numbers go first. Must be greater then zero\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"discovery_rule[enabled]\",\"description\":\"\\n\\u003cp\\u003eflag + is used for temporary shutdown of rules\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"discovery_rule[location_ids]\",\"description\":\"\\n\\u003cp\\u003elocation + ID for provisioned hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"discovery_rule[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eorganization + ID for provisioned hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/discovery_rules/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/v2/discovery_rules/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a rule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"templates\":{\"doc_url\":\"/apidoc/v2/templates\",\"id\":\"templates\",\"api_url\":\"/api\",\"name\":\"Templates\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/templates/import\",\"name\":\"import\",\"apis\":[{\"api_url\":\"/api/templates/import\",\"http_method\":\"POST\",\"short_description\":\"Initiate + Import\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"prefix\",\"full_name\":\"prefix\",\"description\":\"\\n\\u003cp\\u003eThe + string all imported templates should begin with.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"associate\",\"full_name\":\"associate\",\"description\":\"\\n\\u003cp\\u003eAssociate + to OS\\u0026#39;s, Locations \\u0026amp; Organizations. Options are: always, + new or never.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ealways\\u003c/code\\u003e, \\u003ccode\\u003enew\\u003c/code\\u003e, + \\u003ccode\\u003enever\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"force\",\"full_name\":\"force\",\"description\":\"\\n\\u003cp\\u003eUpdate + templates that are locked\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lock\",\"full_name\":\"lock\",\"description\":\"\\n\\u003cp\\u003eLock + imported templates\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003elock\\u003c/code\\u003e, \\u003ccode\\u003ekeep_lock_new\\u003c/code\\u003e, + \\u003ccode\\u003ekeep\\u003c/code\\u003e, \\u003ccode\\u003eunlock\\u003c/code\\u003e, + \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e0\\u003c/code\\u003e, \\u003ccode\\u003e1\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"verbose\",\"full_name\":\"verbose\",\"description\":\"\\n\\u003cp\\u003eShow + template diff in response\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"branch\",\"full_name\":\"branch\",\"description\":\"\\n\\u003cp\\u003eBranch + in Git repo.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repo\",\"full_name\":\"repo\",\"description\":\"\\n\\u003cp\\u003eOverride + the default repo from settings.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"filter\",\"full_name\":\"filter\",\"description\":\"\\n\\u003cp\\u003eExport + templates with names matching this regex (case-insensitive; snippets are not + filtered).\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"negate\",\"full_name\":\"negate\",\"description\":\"\\n\\u003cp\\u003eNegate + the prefix (for purging).\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dirname\",\"full_name\":\"dirname\",\"description\":\"\\n\\u003cp\\u003eThe + directory within Git repo containing the templates\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"location_ids\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"organization_ids\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/templates/export\",\"name\":\"export\",\"apis\":[{\"api_url\":\"/api/templates/export\",\"http_method\":\"POST\",\"short_description\":\"Initiate + Export\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"metadata_export_mode\",\"full_name\":\"metadata_export_mode\",\"description\":\"\\n\\u003cp\\u003eSpecify + how to handle metadata\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003erefresh\\u003c/code\\u003e, \\u003ccode\\u003ekeep\\u003c/code\\u003e, + \\u003ccode\\u003eremove\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"commit_msg\",\"full_name\":\"commit_msg\",\"description\":\"\\n\\u003cp\\u003eCustom + commit message for templates export\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"branch\",\"full_name\":\"branch\",\"description\":\"\\n\\u003cp\\u003eBranch + in Git repo.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"repo\",\"full_name\":\"repo\",\"description\":\"\\n\\u003cp\\u003eOverride + the default repo from settings.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"filter\",\"full_name\":\"filter\",\"description\":\"\\n\\u003cp\\u003eExport + templates with names matching this regex (case-insensitive; snippets are not + filtered).\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"negate\",\"full_name\":\"negate\",\"description\":\"\\n\\u003cp\\u003eNegate + the prefix (for purging).\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dirname\",\"full_name\":\"dirname\",\"description\":\"\\n\\u003cp\\u003eThe + directory within Git repo containing the templates\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"location_ids\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"organization_ids\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"disks\":{\"doc_url\":\"/apidoc/v2/disks\",\"id\":\"disks\",\"api_url\":\"/api\",\"name\":\"Disks\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/disks/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/bootdisk\",\"http_method\":\"GET\",\"short_description\":\"Boot + disks\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/disks/generic\",\"name\":\"generic\",\"apis\":[{\"api_url\":\"/api/bootdisk/generic\",\"http_method\":\"GET\",\"short_description\":\"Download + generic image\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/disks/host\",\"name\":\"host\",\"apis\":[{\"api_url\":\"/api/bootdisk/hosts/:host_id\",\"http_method\":\"GET\",\"short_description\":\"Download + host image\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"full\",\"full_name\":\"full\",\"description\":\"\\n\\u003cp\\u003eTrue + for full, false for basic reusable image\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"subnet_disks\":{\"doc_url\":\"/apidoc/v2/subnet_disks\",\"id\":\"subnet_disks\",\"api_url\":\"/api\",\"name\":\"Subnet_disks\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/subnet_disks/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/bootdisk\",\"http_method\":\"GET\",\"short_description\":\"Subnet + boot disks\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/subnet_disks/subnet\",\"name\":\"subnet\",\"apis\":[{\"api_url\":\"/api/bootdisk/subnets/:subnet_id\",\"http_method\":\"GET\",\"short_description\":\"Download + subnet generic image\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"subnet_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"preupgrade_reports\":{\"doc_url\":\"/apidoc/v2/preupgrade_reports\",\"id\":\"preupgrade_reports\",\"api_url\":\"/api\",\"name\":\"Preupgrade_reports\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/preupgrade_reports/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/preupgrade_reports\",\"http_method\":\"GET\",\"short_description\":\"List + Preupgrade reports\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/preupgrade_reports/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/preupgrade_reports/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + Preupgrade report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/preupgrade_reports/job_invocation\",\"name\":\"job_invocation\",\"apis\":[{\"api_url\":\"/api/job_invocations/:id/preupgrade_reports\",\"http_method\":\"GET\",\"short_description\":\"List + Preupgrade reports for Job invocation\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"arf_reports\":{\"doc_url\":\"/apidoc/v2/arf_reports\",\"id\":\"arf_reports\",\"api_url\":\"/api\",\"name\":\"Arf_reports\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/arf_reports/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/compliance/arf_reports\",\"http_method\":\"GET\",\"short_description\":\"List + ARF reports\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"compliance_policy\",\"type\":\"string\"},{\"name\":\"compliance_status\",\"values\":[\"compliant\",\"incompliant\",\"inconclusive\"]},{\"name\":\"comply_with\",\"type\":\"string\"},{\"name\":\"eventful\",\"values\":[\"true\",\"false\"]},{\"name\":\"host\",\"type\":\"string\"},{\"name\":\"host_collection\",\"type\":\"string\"},{\"name\":\"host_id\",\"type\":\"integer\"},{\"name\":\"host_owner_id\",\"type\":\"integer\"},{\"name\":\"hostgroup\",\"type\":\"string\"},{\"name\":\"hostgroup_fullname\",\"type\":\"string\"},{\"name\":\"hostgroup_title\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"inconclusive_with\",\"type\":\"string\"},{\"name\":\"last_for\",\"values\":[\"host\",\"policy\"]},{\"name\":\"last_report\",\"type\":\"datetime\"},{\"name\":\"lifecycle_environment\",\"type\":\"\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"log\",\"type\":\"text\"},{\"name\":\"not_comply_with\",\"type\":\"string\"},{\"name\":\"openscap_proxy\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"origin\",\"type\":\"string\"},{\"name\":\"policy\",\"type\":\"string\"},{\"name\":\"reported\",\"type\":\"datetime\"},{\"name\":\"resource\",\"type\":\"text\"},{\"name\":\"xccdf_rule_failed\",\"type\":\"string\"},{\"name\":\"xccdf_rule_name\",\"type\":\"text\"},{\"name\":\"xccdf_rule_othered\",\"type\":\"string\"},{\"name\":\"xccdf_rule_passed\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/arf_reports/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/compliance/arf_reports/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an ARF report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/arf_reports/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/compliance/arf_reports/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + an ARF Report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/arf_reports/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/compliance/arf/:cname/:policy_id/:date\",\"http_method\":\"POST\",\"short_description\":\"Upload + an ARF report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cname\",\"full_name\":\"cname\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"policy_id\",\"full_name\":\"policy_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"date\",\"full_name\":\"date\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/arf_reports/download\",\"name\":\"download\",\"apis\":[{\"api_url\":\"/api/compliance/arf_reports/:id/download\",\"http_method\":\"GET\",\"short_description\":\"Download + bzipped ARF report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/arf_reports/download_html\",\"name\":\"download_html\",\"apis\":[{\"api_url\":\"/api/compliance/arf_reports/:id/download_html\",\"http_method\":\"GET\",\"short_description\":\"Download + ARF report in HTML\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"oval_contents\":{\"doc_url\":\"/apidoc/v2/oval_contents\",\"id\":\"oval_contents\",\"api_url\":\"/api\",\"name\":\"Oval_contents\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/oval_contents/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/compliance/oval_contents\",\"http_method\":\"GET\",\"short_description\":\"List + OVAL contents\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_contents/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/compliance/oval_contents/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an OVAL content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_contents/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/compliance/oval_contents\",\"http_method\":\"POST\",\"short_description\":\"Create + OVAL content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"oval_content\",\"full_name\":\"oval_content\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"oval_content[name]\",\"description\":\"\\n\\u003cp\\u003eOVAL + content name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_file\",\"full_name\":\"oval_content[scap_file]\",\"description\":\"\\n\\u003cp\\u003eXML + containing OVAL content\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"File\",\"expected_type\":\"file\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"original_filename\",\"full_name\":\"oval_content[original_filename]\",\"description\":\"\\n\\u003cp\\u003eOriginal + file name of the OVAL content file\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"oval_content[url]\",\"description\":\"\\n\\u003cp\\u003eURL + of the OVAL content file\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"oval_content[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"oval_content[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_contents/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/compliance/oval_contents/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an OVAL content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"oval_content\",\"full_name\":\"oval_content\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"oval_content[name]\",\"description\":\"\\n\\u003cp\\u003eOVAL + content name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_file\",\"full_name\":\"oval_content[scap_file]\",\"description\":\"\\n\\u003cp\\u003eXML + containing OVAL content\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"File\",\"expected_type\":\"file\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"original_filename\",\"full_name\":\"oval_content[original_filename]\",\"description\":\"\\n\\u003cp\\u003eOriginal + file name of the OVAL content file\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"oval_content[url]\",\"description\":\"\\n\\u003cp\\u003eURL + of the OVAL content file\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"oval_content[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"oval_content[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_contents/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/compliance/oval_contents/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Deletes + an OVAL content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_contents/sync\",\"name\":\"sync\",\"apis\":[{\"api_url\":\"/api/compliance/oval_contents/sync\",\"http_method\":\"POST\",\"short_description\":\"Sync + contents that have remote source URL\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"oval_policies\":{\"doc_url\":\"/apidoc/v2/oval_policies\",\"id\":\"oval_policies\",\"api_url\":\"/api\",\"name\":\"Oval_policies\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/oval_policies/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/compliance/oval_policies\",\"http_method\":\"GET\",\"short_description\":\"List + OVAL Policies\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_policies/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/compliance/oval_policies/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an OVAL Policy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_policies/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/compliance/oval_policies\",\"http_method\":\"POST\",\"short_description\":\"Create + an OVAL Policy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"oval_policy\",\"full_name\":\"oval_policy\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"oval_policy[name]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"oval_content_id\",\"full_name\":\"oval_policy[oval_content_id]\",\"description\":\"\\n\\u003cp\\u003ePolicy + OVAL content ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"oval_policy[description]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"period\",\"full_name\":\"oval_policy[period]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy schedule period (weekly, monthly, custom)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"weekday\",\"full_name\":\"oval_policy[weekday]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy schedule weekday (only if period == \u201Cweekly\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"day_of_month\",\"full_name\":\"oval_policy[day_of_month]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy schedule day of month (only if period == \u201Cmonthly\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cron_line\",\"full_name\":\"oval_policy[cron_line]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy schedule cron line (only if period == \u201Ccustom\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"oval_policy[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"oval_policy[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_policies/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/compliance/oval_policies/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an OVAL Policy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"oval_policy\",\"full_name\":\"oval_policy\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"oval_policy[name]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"oval_content_id\",\"full_name\":\"oval_policy[oval_content_id]\",\"description\":\"\\n\\u003cp\\u003ePolicy + OVAL content ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"oval_policy[description]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"period\",\"full_name\":\"oval_policy[period]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy schedule period (weekly, monthly, custom)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"weekday\",\"full_name\":\"oval_policy[weekday]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy schedule weekday (only if period == \u201Cweekly\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"day_of_month\",\"full_name\":\"oval_policy[day_of_month]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy schedule day of month (only if period == \u201Cmonthly\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cron_line\",\"full_name\":\"oval_policy[cron_line]\",\"description\":\"\\n\\u003cp\\u003eOVAL + Policy schedule cron line (only if period == \u201Ccustom\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"oval_policy[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"oval_policy[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_policies/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/compliance/oval_policies/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + an OVAL Policy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_policies/assign_hostgroups\",\"name\":\"assign_hostgroups\",\"apis\":[{\"api_url\":\"/api/compliance/oval_policies/:id/assign_hostgroups\",\"http_method\":\"POST\",\"short_description\":\"Assign + hostgroups to an OVAL Policy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_ids\",\"full_name\":\"hostgroup_ids\",\"description\":\"\\n\\u003cp\\u003eArray + of hostgroup IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_policies/assign_hosts\",\"name\":\"assign_hosts\",\"apis\":[{\"api_url\":\"/api/compliance/oval_policies/:id/assign_hosts\",\"http_method\":\"POST\",\"short_description\":\"Assign + hosts to an OVAL Policy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"host_ids\",\"description\":\"\\n\\u003cp\\u003eArray + of host IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/oval_policies/oval_content\",\"name\":\"oval_content\",\"apis\":[{\"api_url\":\"/api/compliance/oval_policies/:id/oval_content\",\"http_method\":\"GET\",\"short_description\":\"Show + a policy's OVAL content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"oval_reports\":{\"doc_url\":\"/apidoc/v2/oval_reports\",\"id\":\"oval_reports\",\"api_url\":\"/api\",\"name\":\"Oval_reports\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/oval_reports/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/compliance/oval_reports/:cname/:oval_policy_id/:date\",\"http_method\":\"POST\",\"short_description\":\"Upload + an OVAL report - a list of CVEs for given host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cname\",\"full_name\":\"cname\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"oval_policy_id\",\"full_name\":\"oval_policy_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"date\",\"full_name\":\"date\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"policies\":{\"doc_url\":\"/apidoc/v2/policies\",\"id\":\"policies\",\"api_url\":\"/api\",\"name\":\"Policies\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/policies/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/compliance/policies\",\"http_method\":\"GET\",\"short_description\":\"List + Policies\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"content\",\"type\":\"string\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"profile\",\"type\":\"string\"},{\"name\":\"tailoring_file\",\"type\":\"string\"},{\"name\":\"tailoring_file_profile\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/policies/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/compliance/policies/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a Policy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/policies/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/compliance/policies\",\"http_method\":\"POST\",\"short_description\":\"Create + a Policy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"policy\",\"full_name\":\"policy\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"policy[name]\",\"description\":\"\\n\\u003cp\\u003ePolicy + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"policy[description]\",\"description\":\"\\n\\u003cp\\u003ePolicy + description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_content_id\",\"full_name\":\"policy[scap_content_id]\",\"description\":\"\\n\\u003cp\\u003ePolicy + SCAP content ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_content_profile_id\",\"full_name\":\"policy[scap_content_profile_id]\",\"description\":\"\\n\\u003cp\\u003ePolicy + SCAP content profile ID\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"period\",\"full_name\":\"policy[period]\",\"description\":\"\\n\\u003cp\\u003ePolicy + schedule period (weekly, monthly, custom)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"weekday\",\"full_name\":\"policy[weekday]\",\"description\":\"\\n\\u003cp\\u003ePolicy + schedule weekday (only if period == \u201Cweekly\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"day_of_month\",\"full_name\":\"policy[day_of_month]\",\"description\":\"\\n\\u003cp\\u003ePolicy + schedule day of month (only if period == \u201Cmonthly\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cron_line\",\"full_name\":\"policy[cron_line]\",\"description\":\"\\n\\u003cp\\u003ePolicy + schedule cron line (only if period == \u201Ccustom\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_ids\",\"full_name\":\"policy[hostgroup_ids]\",\"description\":\"\\n\\u003cp\\u003eApply + policy to host groups\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"policy[host_ids]\",\"description\":\"\\n\\u003cp\\u003eApply + policy to hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tailoring_file_id\",\"full_name\":\"policy[tailoring_file_id]\",\"description\":\"\\n\\u003cp\\u003eTailoring + file ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tailoring_file_profile_id\",\"full_name\":\"policy[tailoring_file_profile_id]\",\"description\":\"\\n\\u003cp\\u003eTailoring + file profile ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"deploy_by\",\"full_name\":\"policy[deploy_by]\",\"description\":\"\\n\\u003cp\\u003eHow + the policy should be deployed\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003epuppet\\u003c/code\\u003e, \\u003ccode\\u003eansible\\u003c/code\\u003e, + \\u003ccode\\u003emanual\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"policy[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"policy[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/policies/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/compliance/policies/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a Policy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"policy\",\"full_name\":\"policy\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"policy[name]\",\"description\":\"\\n\\u003cp\\u003ePolicy + name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"policy[description]\",\"description\":\"\\n\\u003cp\\u003ePolicy + description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_content_id\",\"full_name\":\"policy[scap_content_id]\",\"description\":\"\\n\\u003cp\\u003ePolicy + SCAP content ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_content_profile_id\",\"full_name\":\"policy[scap_content_profile_id]\",\"description\":\"\\n\\u003cp\\u003ePolicy + SCAP content profile ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"period\",\"full_name\":\"policy[period]\",\"description\":\"\\n\\u003cp\\u003ePolicy + schedule period (weekly, monthly, custom)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"weekday\",\"full_name\":\"policy[weekday]\",\"description\":\"\\n\\u003cp\\u003ePolicy + schedule weekday (only if period == \u201Cweekly\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"day_of_month\",\"full_name\":\"policy[day_of_month]\",\"description\":\"\\n\\u003cp\\u003ePolicy + schedule day of month (only if period == \u201Cmonthly\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"cron_line\",\"full_name\":\"policy[cron_line]\",\"description\":\"\\n\\u003cp\\u003ePolicy + schedule cron line (only if period == \u201Ccustom\u201D)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_ids\",\"full_name\":\"policy[hostgroup_ids]\",\"description\":\"\\n\\u003cp\\u003eApply + policy to host groups\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"policy[host_ids]\",\"description\":\"\\n\\u003cp\\u003eApply + policy to hosts\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tailoring_file_id\",\"full_name\":\"policy[tailoring_file_id]\",\"description\":\"\\n\\u003cp\\u003eTailoring + file ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tailoring_file_profile_id\",\"full_name\":\"policy[tailoring_file_profile_id]\",\"description\":\"\\n\\u003cp\\u003eTailoring + file profile ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"deploy_by\",\"full_name\":\"policy[deploy_by]\",\"description\":\"\\n\\u003cp\\u003eHow + the policy should be deployed\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003epuppet\\u003c/code\\u003e, \\u003ccode\\u003eansible\\u003c/code\\u003e, + \\u003ccode\\u003emanual\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"policy[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"policy[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/policies/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/compliance/policies/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a Policy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/policies/content\",\"name\":\"content\",\"apis\":[{\"api_url\":\"/api/compliance/policies/:id/content\",\"http_method\":\"GET\",\"short_description\":\"Show + a policy's SCAP content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/policies/tailoring\",\"name\":\"tailoring\",\"apis\":[{\"api_url\":\"/api/compliance/policies/:id/tailoring\",\"http_method\":\"GET\",\"short_description\":\"Show + a policy's Tailoring file\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"scap_content_profiles\":{\"doc_url\":\"/apidoc/v2/scap_content_profiles\",\"id\":\"scap_content_profiles\",\"api_url\":\"/api\",\"name\":\"Scap_content_profiles\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/scap_content_profiles/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/compliance/scap_content_profiles\",\"http_method\":\"GET\",\"short_description\":\"List + SCAP content profiles\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"profile_id\",\"type\":\"string\"},{\"name\":\"title\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"scap_contents\":{\"doc_url\":\"/apidoc/v2/scap_contents\",\"id\":\"scap_contents\",\"api_url\":\"/api\",\"name\":\"Scap_contents\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/scap_contents/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/compliance/scap_contents\",\"http_method\":\"GET\",\"short_description\":\"List + SCAP contents\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"created_at\",\"type\":\"datetime\"},{\"name\":\"filename\",\"type\":\"string\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"title\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/scap_contents/xml\",\"name\":\"xml\",\"apis\":[{\"api_url\":\"/api/compliance/scap_contents/:id/xml\",\"http_method\":\"GET\",\"short_description\":\"Download + an SCAP content as XML\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/scap_contents/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/compliance/scap_contents/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an SCAP content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/scap_contents/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/compliance/scap_contents\",\"http_method\":\"POST\",\"short_description\":\"Create + SCAP content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_content\",\"full_name\":\"scap_content\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"title\",\"full_name\":\"scap_content[title]\",\"description\":\"\\n\\u003cp\\u003eSCAP + content name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_file\",\"full_name\":\"scap_content[scap_file]\",\"description\":\"\\n\\u003cp\\u003eXML + containing SCAP content\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"original_filename\",\"full_name\":\"scap_content[original_filename]\",\"description\":\"\\n\\u003cp\\u003eOriginal + file name of the XML file\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"scap_content[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"scap_content[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/scap_contents/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/compliance/scap_contents/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an SCAP content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_content\",\"full_name\":\"scap_content\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"title\",\"full_name\":\"scap_content[title]\",\"description\":\"\\n\\u003cp\\u003eSCAP + content name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_file\",\"full_name\":\"scap_content[scap_file]\",\"description\":\"\\n\\u003cp\\u003eXML + containing SCAP content\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"original_filename\",\"full_name\":\"scap_content[original_filename]\",\"description\":\"\\n\\u003cp\\u003eOriginal + file name of the XML file\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"scap_content[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"scap_content[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/scap_contents/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/compliance/scap_contents/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Deletes + an SCAP content\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/scap_contents/bulk_upload\",\"name\":\"bulk_upload\",\"apis\":[{\"api_url\":\"/api/compliance/scap_contents/bulk_upload\",\"http_method\":\"POST\",\"short_description\":\"Upload + scap contents in bulk\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"type\",\"full_name\":\"type\",\"description\":\"\\n\\u003cp\\u003eType + of the upload\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003efiles\\u003c/code\\u003e, \\u003ccode\\u003edirectory\\u003c/code\\u003e, + \\u003ccode\\u003edefault\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"files\",\"full_name\":\"files\",\"description\":\"\\n\\u003cp\\u003eFile + paths to upload when using \u201Cfiles\u201D upload type\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"directory\",\"full_name\":\"directory\",\"description\":\"\\n\\u003cp\\u003eDirectory + to upload when using \u201Cdirectory\u201D upload type\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"tailoring_files\":{\"doc_url\":\"/apidoc/v2/tailoring_files\",\"id\":\"tailoring_files\",\"api_url\":\"/api\",\"name\":\"Tailoring_files\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/tailoring_files/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/compliance/tailoring_files\",\"http_method\":\"GET\",\"short_description\":\"List + Tailoring files\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"created_at\",\"type\":\"datetime\"},{\"name\":\"filename\",\"type\":\"string\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/tailoring_files/xml\",\"name\":\"xml\",\"apis\":[{\"api_url\":\"/api/compliance/tailoring_files/:id/xml\",\"http_method\":\"GET\",\"short_description\":\"Download + a Tailoring file as XML\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/tailoring_files/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/compliance/tailoring_files/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a Tailoring file\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/tailoring_files/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/compliance/tailoring_files\",\"http_method\":\"POST\",\"short_description\":\"Create + a Tailoring file\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tailoring_file\",\"full_name\":\"tailoring_file\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"tailoring_file[name]\",\"description\":\"\\n\\u003cp\\u003eTailoring + file name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_file\",\"full_name\":\"tailoring_file[scap_file]\",\"description\":\"\\n\\u003cp\\u003eXML + containing tailoring file\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"original_filename\",\"full_name\":\"tailoring_file[original_filename]\",\"description\":\"\\n\\u003cp\\u003eOriginal + file name of the XML file\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"tailoring_file[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"tailoring_file[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/tailoring_files/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/compliance/tailoring_files/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a Tailoring file\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tailoring_file\",\"full_name\":\"tailoring_file\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"tailoring_file[name]\",\"description\":\"\\n\\u003cp\\u003eTailoring + file name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"scap_file\",\"full_name\":\"tailoring_file[scap_file]\",\"description\":\"\\n\\u003cp\\u003eXML + containing tailoring file\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"original_filename\",\"full_name\":\"tailoring_file[original_filename]\",\"description\":\"\\n\\u003cp\\u003eOriginal + file name of the XML file\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"tailoring_file[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"tailoring_file[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/tailoring_files/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/compliance/tailoring_files/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Deletes + a Tailoring file\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"inventory\":{\"doc_url\":\"/apidoc/v2/inventory\",\"id\":\"inventory\",\"api_url\":\"/api\",\"name\":\"Inventory\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/inventory/download_file\",\"name\":\"download_file\",\"apis\":[{\"api_url\":\"/api/organizations/:organization_id/rh_cloud/report\",\"http_method\":\"GET\",\"short_description\":\"Download + latest report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/inventory/generate_report\",\"name\":\"generate_report\",\"apis\":[{\"api_url\":\"/api/organizations/:organization_id/rh_cloud/report\",\"http_method\":\"POST\",\"short_description\":\"Start + report generation\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"disconnected\",\"full_name\":\"disconnected\",\"description\":\"\\n\\u003cp\\u003eGenerate + the report, but do not upload\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/inventory/get_hosts\",\"name\":\"get_hosts\",\"apis\":[{\"api_url\":\"/api/organizations/:organization_id/rh_cloud/missing_hosts\",\"http_method\":\"GET\",\"short_description\":\"Grab + hosts that are missing in RH Cloud\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/inventory/remove_hosts\",\"name\":\"remove_hosts\",\"apis\":[{\"api_url\":\"/api/organizations/:organization_id/rh_cloud/missing_hosts\",\"http_method\":\"POST\",\"short_description\":\"Grab + hosts that are missing in RH Cloud\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search_term\",\"full_name\":\"search_term\",\"description\":\"\\n\\u003cp\\u003eScoped + search string for host removal\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/inventory/sync_inventory_status\",\"name\":\"sync_inventory_status\",\"apis\":[{\"api_url\":\"/api/organizations/:organization_id/rh_cloud/inventory_sync\",\"http_method\":\"POST\",\"short_description\":\"Start + inventory synchronization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/inventory/enable_cloud_connector\",\"name\":\"enable_cloud_connector\",\"apis\":[{\"api_url\":\"/api/rh_cloud/enable_connector\",\"http_method\":\"POST\",\"short_description\":\"Enable + cloud connector\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"webhook_templates\":{\"doc_url\":\"/apidoc/v2/webhook_templates\",\"id\":\"webhook_templates\",\"api_url\":\"/api\",\"name\":\"Webhook_templates\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/webhook_templates/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/webhook_templates\",\"http_method\":\"GET\",\"short_description\":\"List + webhook templates\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"default\",\"values\":[\"true\",\"false\"]},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"locked\",\"values\":[\"true\",\"false\"]},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"snippet\",\"values\":[\"true\",\"false\"]},{\"name\":\"template\",\"type\":\"text\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhook_templates/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/webhook_templates/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + webhook template details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhook_templates/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/webhook_templates\",\"http_method\":\"POST\",\"short_description\":\"Create + a webhook template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"webhook_template\",\"full_name\":\"webhook_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"webhook_template[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"webhook_template[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"webhook_template[template]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"snippet\",\"full_name\":\"webhook_template[snippet]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"audit_comment\",\"full_name\":\"webhook_template[audit_comment]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locked\",\"full_name\":\"webhook_template[locked]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is locked for editing\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"webhook_template[default]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is added automatically to new organizations and locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"webhook_template[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"webhook_template[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhook_templates/import\",\"name\":\"import\",\"apis\":[{\"api_url\":\"/api/webhook_templates/import\",\"http_method\":\"POST\",\"short_description\":\"Import + a webhook template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"webhook_template\",\"full_name\":\"webhook_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"webhook_template[name]\",\"description\":\"\\n\\u003cp\\u003eTemplate + name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"webhook_template[template]\",\"description\":\"\\n\\u003cp\\u003eTemplate + contents including metadata\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"webhook_template[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"webhook_template[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"options\",\"full_name\":\"options\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"force\",\"full_name\":\"options[force]\",\"description\":\"\\n\\u003cp\\u003euse + if you want update locked templates\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"associate\",\"full_name\":\"options[associate]\",\"description\":\"\\n\\u003cp\\u003edetermines + when the template should associate objects based on metadata, new means only + when new template is being created, always means both for new and existing + template which is only being updated, never ignores metadata\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003enew\\u003c/code\\u003e, \\u003ccode\\u003ealways\\u003c/code\\u003e, + \\u003ccode\\u003enever\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lock\",\"full_name\":\"options[lock]\",\"description\":\"\\n\\u003cp\\u003elock + imported templates (false by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"options[default]\",\"description\":\"\\n\\u003cp\\u003emakes + the template default meaning it will be automatically associated with newly + created organizations and locations (false by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhook_templates/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/webhook_templates/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a webhook template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"webhook_template\",\"full_name\":\"webhook_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"webhook_template[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"webhook_template[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"webhook_template[template]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"snippet\",\"full_name\":\"webhook_template[snippet]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"audit_comment\",\"full_name\":\"webhook_template[audit_comment]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locked\",\"full_name\":\"webhook_template[locked]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is locked for editing\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"webhook_template[default]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is added automatically to new organizations and locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"webhook_template[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"webhook_template[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhook_templates/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/webhook_templates/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a webhook template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhook_templates/clone\",\"name\":\"clone\",\"apis\":[{\"api_url\":\"/api/webhook_templates/:id/clone\",\"http_method\":\"POST\",\"short_description\":\"Clone + a template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"webhook_template\",\"full_name\":\"webhook_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"webhook_template[name]\",\"description\":\"\\n\\u003cp\\u003eTemplate + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhook_templates/export\",\"name\":\"export\",\"apis\":[{\"api_url\":\"/api/webhook_templates/:id/export\",\"http_method\":\"GET\",\"short_description\":\"Export + a webhook template to ERB\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"webhooks\":{\"doc_url\":\"/apidoc/v2/webhooks\",\"id\":\"webhooks\",\"api_url\":\"/api\",\"name\":\"Webhooks\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/webhooks/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/webhooks\",\"http_method\":\"GET\",\"short_description\":\"List + Webhooks\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"enabled\",\"values\":[\"true\",\"false\"]},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"target_url\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhooks/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/webhooks/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + Webhook details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhooks/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/webhooks\",\"http_method\":\"POST\",\"short_description\":\"Create + a Webhook\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"webhook\",\"full_name\":\"webhook\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"webhook[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"target_url\",\"full_name\":\"webhook[target_url]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_method\",\"full_name\":\"webhook[http_method]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ePOST\\u003c/code\\u003e, \\u003ccode\\u003eGET\\u003c/code\\u003e, + \\u003ccode\\u003ePUT\\u003c/code\\u003e, \\u003ccode\\u003eDELETE\\u003c/code\\u003e, + \\u003ccode\\u003ePATCH\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_content_type\",\"full_name\":\"webhook[http_content_type]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"event\",\"full_name\":\"webhook[event]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eactions.katello.capsule_content.sync_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.capsule_content.sync_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.content_view.promote_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.content_view.promote_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.content_view.publish_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.content_view.publish_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.repository.sync_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.repository.sync_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_configure_cloud_connector_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_enable_web_console_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_run_capsule_upgrade_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_run_host_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_run_insights_plan_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_run_playbook_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_foreman_openscap_run_oval_scans_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_foreman_openscap_run_scans_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_errata_install_by_search_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_errata_install_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_group_install_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_group_remove_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_group_update_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_host_tracer_resolve_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_module_stream_action_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_package_install_by_search_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_package_install_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_package_remove_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_package_update_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_packages_remove_by_search_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_packages_update_by_search_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_service_restart_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_leapp_preupgrade_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_leapp_remediation_plan_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_leapp_upgrade_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_puppet_run_host_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_rh_cloud_remediate_hosts_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_run_script_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_hosts_job_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_hosts_job_running\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_hosts_job_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003ebuild_entered\\u003c/code\\u003e, \\u003ccode\\u003ebuild_exited\\u003c/code\\u003e, + \\u003ccode\\u003econtent_view_created\\u003c/code\\u003e, \\u003ccode\\u003econtent_view_destroyed\\u003c/code\\u003e, + \\u003ccode\\u003econtent_view_updated\\u003c/code\\u003e, \\u003ccode\\u003edomain_created\\u003c/code\\u003e, + \\u003ccode\\u003edomain_destroyed\\u003c/code\\u003e, \\u003ccode\\u003edomain_updated\\u003c/code\\u003e, + \\u003ccode\\u003ehost_created\\u003c/code\\u003e, \\u003ccode\\u003ehost_destroyed\\u003c/code\\u003e, + \\u003ccode\\u003ehost_facts_updated\\u003c/code\\u003e, \\u003ccode\\u003ehost_updated\\u003c/code\\u003e, + \\u003ccode\\u003ehostgroup_created\\u003c/code\\u003e, \\u003ccode\\u003ehostgroup_destroyed\\u003c/code\\u003e, + \\u003ccode\\u003ehostgroup_updated\\u003c/code\\u003e, \\u003ccode\\u003emodel_created\\u003c/code\\u003e, + \\u003ccode\\u003emodel_destroyed\\u003c/code\\u003e, \\u003ccode\\u003emodel_updated\\u003c/code\\u003e, + \\u003ccode\\u003estatus_changed\\u003c/code\\u003e, \\u003ccode\\u003esubnet_created\\u003c/code\\u003e, + \\u003ccode\\u003esubnet_destroyed\\u003c/code\\u003e, \\u003ccode\\u003esubnet_updated\\u003c/code\\u003e, + \\u003ccode\\u003euser_created\\u003c/code\\u003e, \\u003ccode\\u003euser_destroyed\\u003c/code\\u003e, + \\u003ccode\\u003euser_updated\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"webhook_template_id\",\"full_name\":\"webhook[webhook_template_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"webhook[enabled]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"verify_ssl\",\"full_name\":\"webhook[verify_ssl]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_ca_certs\",\"full_name\":\"webhook[ssl_ca_certs]\",\"description\":\"\\n\\u003cp\\u003eX509 + Certification Authorities concatenated in PEM format\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user\",\"full_name\":\"webhook[user]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"webhook[password]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_headers\",\"full_name\":\"webhook[http_headers]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"proxy_authorization\",\"full_name\":\"webhook[proxy_authorization]\",\"description\":\"\\n\\u003cp\\u003eAuthorize + with Satellite client certificate and validate capsule CA from Settings\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhooks/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/webhooks/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a Webhook\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"webhook\",\"full_name\":\"webhook\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"webhook[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"target_url\",\"full_name\":\"webhook[target_url]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_method\",\"full_name\":\"webhook[http_method]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ePOST\\u003c/code\\u003e, \\u003ccode\\u003eGET\\u003c/code\\u003e, + \\u003ccode\\u003ePUT\\u003c/code\\u003e, \\u003ccode\\u003eDELETE\\u003c/code\\u003e, + \\u003ccode\\u003ePATCH\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_content_type\",\"full_name\":\"webhook[http_content_type]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"event\",\"full_name\":\"webhook[event]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eactions.katello.capsule_content.sync_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.capsule_content.sync_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.content_view.promote_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.content_view.promote_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.content_view.publish_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.content_view.publish_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.repository.sync_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.katello.repository.sync_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_configure_cloud_connector_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_enable_web_console_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_run_capsule_upgrade_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_run_host_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_run_insights_plan_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_ansible_run_playbook_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_foreman_openscap_run_oval_scans_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_foreman_openscap_run_scans_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_errata_install_by_search_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_errata_install_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_group_install_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_group_remove_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_group_update_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_host_tracer_resolve_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_module_stream_action_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_package_install_by_search_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_package_install_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_package_remove_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_package_update_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_packages_remove_by_search_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_packages_update_by_search_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_katello_service_restart_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_leapp_preupgrade_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_leapp_remediation_plan_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_leapp_upgrade_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_puppet_run_host_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_rh_cloud_remediate_hosts_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_run_script_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_host_job_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_hosts_job_failed\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_hosts_job_running\\u003c/code\\u003e, + \\u003ccode\\u003eactions.remote_execution.run_hosts_job_succeeded\\u003c/code\\u003e, + \\u003ccode\\u003ebuild_entered\\u003c/code\\u003e, \\u003ccode\\u003ebuild_exited\\u003c/code\\u003e, + \\u003ccode\\u003econtent_view_created\\u003c/code\\u003e, \\u003ccode\\u003econtent_view_destroyed\\u003c/code\\u003e, + \\u003ccode\\u003econtent_view_updated\\u003c/code\\u003e, \\u003ccode\\u003edomain_created\\u003c/code\\u003e, + \\u003ccode\\u003edomain_destroyed\\u003c/code\\u003e, \\u003ccode\\u003edomain_updated\\u003c/code\\u003e, + \\u003ccode\\u003ehost_created\\u003c/code\\u003e, \\u003ccode\\u003ehost_destroyed\\u003c/code\\u003e, + \\u003ccode\\u003ehost_facts_updated\\u003c/code\\u003e, \\u003ccode\\u003ehost_updated\\u003c/code\\u003e, + \\u003ccode\\u003ehostgroup_created\\u003c/code\\u003e, \\u003ccode\\u003ehostgroup_destroyed\\u003c/code\\u003e, + \\u003ccode\\u003ehostgroup_updated\\u003c/code\\u003e, \\u003ccode\\u003emodel_created\\u003c/code\\u003e, + \\u003ccode\\u003emodel_destroyed\\u003c/code\\u003e, \\u003ccode\\u003emodel_updated\\u003c/code\\u003e, + \\u003ccode\\u003estatus_changed\\u003c/code\\u003e, \\u003ccode\\u003esubnet_created\\u003c/code\\u003e, + \\u003ccode\\u003esubnet_destroyed\\u003c/code\\u003e, \\u003ccode\\u003esubnet_updated\\u003c/code\\u003e, + \\u003ccode\\u003euser_created\\u003c/code\\u003e, \\u003ccode\\u003euser_destroyed\\u003c/code\\u003e, + \\u003ccode\\u003euser_updated\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"webhook_template_id\",\"full_name\":\"webhook[webhook_template_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"enabled\",\"full_name\":\"webhook[enabled]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"verify_ssl\",\"full_name\":\"webhook[verify_ssl]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssl_ca_certs\",\"full_name\":\"webhook[ssl_ca_certs]\",\"description\":\"\\n\\u003cp\\u003eX509 + Certification Authorities concatenated in PEM format\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user\",\"full_name\":\"webhook[user]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"webhook[password]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_headers\",\"full_name\":\"webhook[http_headers]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"proxy_authorization\",\"full_name\":\"webhook[proxy_authorization]\",\"description\":\"\\n\\u003cp\\u003eAuthorize + with Satellite client certificate and validate capsule CA from Settings\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhooks/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/webhooks/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a Webhook\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhooks/events\",\"name\":\"events\",\"apis\":[{\"api_url\":\"/api/webhooks/events\",\"http_method\":\"GET\",\"short_description\":\"List + available events for subscription\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/webhooks/test\",\"name\":\"test\",\"apis\":[{\"api_url\":\"/api/webhooks/:id/test\",\"http_method\":\"POST\",\"short_description\":\"Test + a Webhook\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"payload\",\"full_name\":\"payload\",\"description\":\"\\n\\u003cp\\u003eTest + payload will be sent as is. Cant be a JSON object\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"architectures\":{\"doc_url\":\"/apidoc/v2/architectures\",\"id\":\"architectures\",\"api_url\":\"/api\",\"name\":\"Architectures\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/architectures/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/architectures\",\"http_method\":\"GET\",\"short_description\":\"List + all architectures\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/architectures\",\"http_method\":\"GET\",\"short_description\":\"List + all architectures for operating system\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/architectures/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/architectures/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an architecture\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/architectures/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/architectures\",\"http_method\":\"POST\",\"short_description\":\"Create + an architecture\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture\",\"full_name\":\"architecture\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"architecture[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_ids\",\"full_name\":\"architecture[operatingsystem_ids]\",\"description\":\"\\n\\u003cp\\u003eOperating + system IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/architectures/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/architectures/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an architecture\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture\",\"full_name\":\"architecture\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"architecture[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_ids\",\"full_name\":\"architecture[operatingsystem_ids]\",\"description\":\"\\n\\u003cp\\u003eOperating + system IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/architectures/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/architectures/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + an architecture\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"audits\":{\"doc_url\":\"/apidoc/v2/audits\",\"id\":\"audits\",\"api_url\":\"/api\",\"name\":\"Audits\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/audits/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/audits\",\"http_method\":\"GET\",\"short_description\":\"List + all audits\",\"deprecated\":null},{\"api_url\":\"/api/hosts/:host_id/audits\",\"http_method\":\"GET\",\"short_description\":\"List + all audits for a given host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/audits/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/audits/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an audit\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"auth_source_externals\":{\"doc_url\":\"/apidoc/v2/auth_source_externals\",\"id\":\"auth_source_externals\",\"api_url\":\"/api\",\"name\":\"Auth_source_externals\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/auth_source_externals/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/auth_source_externals\",\"http_method\":\"GET\",\"short_description\":\"List + external authentication sources\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/auth_source_externals\",\"http_method\":\"GET\",\"short_description\":\"List + external authentication sources per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/auth_source_externals\",\"http_method\":\"GET\",\"short_description\":\"List + external authentication sources per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/auth_source_externals/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/auth_source_externals/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an external authentication source\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/auth_source_externals/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/auth_source_externals/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an external authentication source\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"auth_source_external\",\"full_name\":\"auth_source_external\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"auth_source_external[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"auth_source_external[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"auth_source_external[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"auth_source_internals\":{\"doc_url\":\"/apidoc/v2/auth_source_internals\",\"id\":\"auth_source_internals\",\"api_url\":\"/api\",\"name\":\"Auth_source_internals\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/auth_source_internals/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/auth_source_internals\",\"http_method\":\"GET\",\"short_description\":\"List + internal authentication sources\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/auth_source_internals/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/auth_source_internals/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an internal authentication source\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"auth_source_ldaps\":{\"doc_url\":\"/apidoc/v2/auth_source_ldaps\",\"id\":\"auth_source_ldaps\",\"api_url\":\"/api\",\"name\":\"Auth_source_ldaps\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/auth_source_ldaps/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/auth_source_ldaps\",\"http_method\":\"GET\",\"short_description\":\"List + all LDAP authentication sources\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/auth_source_ldaps\",\"http_method\":\"GET\",\"short_description\":\"List + LDAP authentication sources per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/auth_source_ldaps\",\"http_method\":\"GET\",\"short_description\":\"List + LDAP authentication sources per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/auth_source_ldaps/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/auth_source_ldaps/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an LDAP authentication source\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/auth_source_ldaps/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/auth_source_ldaps\",\"http_method\":\"POST\",\"short_description\":\"Create + an LDAP authentication source\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"auth_source_ldap\",\"full_name\":\"auth_source_ldap\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"auth_source_ldap[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host\",\"full_name\":\"auth_source_ldap[host]\",\"description\":\"\\n\\u003cp\\u003eThe + hostname of the LDAP server\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"port\",\"full_name\":\"auth_source_ldap[port]\",\"description\":\"\\n\\u003cp\\u003edefaults + to 389\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"account\",\"full_name\":\"auth_source_ldap[account]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"base_dn\",\"full_name\":\"auth_source_ldap[base_dn]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"account_password\",\"full_name\":\"auth_source_ldap[account_password]\",\"description\":\"\\n\\u003cp\\u003erequired + if onthefly_register is true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attr_login\",\"full_name\":\"auth_source_ldap[attr_login]\",\"description\":\"\\n\\u003cp\\u003erequired + if onthefly_register is true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attr_firstname\",\"full_name\":\"auth_source_ldap[attr_firstname]\",\"description\":\"\\n\\u003cp\\u003erequired + if onthefly_register is true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attr_lastname\",\"full_name\":\"auth_source_ldap[attr_lastname]\",\"description\":\"\\n\\u003cp\\u003erequired + if onthefly_register is true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attr_mail\",\"full_name\":\"auth_source_ldap[attr_mail]\",\"description\":\"\\n\\u003cp\\u003erequired + if onthefly_register is true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attr_photo\",\"full_name\":\"auth_source_ldap[attr_photo]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"onthefly_register\",\"full_name\":\"auth_source_ldap[onthefly_register]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup_sync\",\"full_name\":\"auth_source_ldap[usergroup_sync]\",\"description\":\"\\n\\u003cp\\u003esync + external user groups on login\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tls\",\"full_name\":\"auth_source_ldap[tls]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"groups_base\",\"full_name\":\"auth_source_ldap[groups_base]\",\"description\":\"\\n\\u003cp\\u003egroups + base DN\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"use_netgroups\",\"full_name\":\"auth_source_ldap[use_netgroups]\",\"description\":\"\\n\\u003cp\\u003euse + NIS netgroups instead of posix groups, applicable only when server_type is + posix or free_ipa\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"server_type\",\"full_name\":\"auth_source_ldap[server_type]\",\"description\":\"\\n\\u003cp\\u003etype + of the LDAP server\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003efree_ipa\\u003c/code\\u003e, \\u003ccode\\u003eactive_directory\\u003c/code\\u003e, + \\u003ccode\\u003eposix\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ldap_filter\",\"full_name\":\"auth_source_ldap[ldap_filter]\",\"description\":\"\\n\\u003cp\\u003eLDAP + filter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"auth_source_ldap[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"auth_source_ldap[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/auth_source_ldaps/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/auth_source_ldaps/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an LDAP authentication source\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"auth_source_ldap\",\"full_name\":\"auth_source_ldap\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"auth_source_ldap[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host\",\"full_name\":\"auth_source_ldap[host]\",\"description\":\"\\n\\u003cp\\u003eThe + hostname of the LDAP server\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"port\",\"full_name\":\"auth_source_ldap[port]\",\"description\":\"\\n\\u003cp\\u003edefaults + to 389\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"account\",\"full_name\":\"auth_source_ldap[account]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"base_dn\",\"full_name\":\"auth_source_ldap[base_dn]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"account_password\",\"full_name\":\"auth_source_ldap[account_password]\",\"description\":\"\\n\\u003cp\\u003erequired + if onthefly_register is true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attr_login\",\"full_name\":\"auth_source_ldap[attr_login]\",\"description\":\"\\n\\u003cp\\u003erequired + if onthefly_register is true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attr_firstname\",\"full_name\":\"auth_source_ldap[attr_firstname]\",\"description\":\"\\n\\u003cp\\u003erequired + if onthefly_register is true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attr_lastname\",\"full_name\":\"auth_source_ldap[attr_lastname]\",\"description\":\"\\n\\u003cp\\u003erequired + if onthefly_register is true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attr_mail\",\"full_name\":\"auth_source_ldap[attr_mail]\",\"description\":\"\\n\\u003cp\\u003erequired + if onthefly_register is true\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"attr_photo\",\"full_name\":\"auth_source_ldap[attr_photo]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"onthefly_register\",\"full_name\":\"auth_source_ldap[onthefly_register]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup_sync\",\"full_name\":\"auth_source_ldap[usergroup_sync]\",\"description\":\"\\n\\u003cp\\u003esync + external user groups on login\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"tls\",\"full_name\":\"auth_source_ldap[tls]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"groups_base\",\"full_name\":\"auth_source_ldap[groups_base]\",\"description\":\"\\n\\u003cp\\u003egroups + base DN\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"use_netgroups\",\"full_name\":\"auth_source_ldap[use_netgroups]\",\"description\":\"\\n\\u003cp\\u003euse + NIS netgroups instead of posix groups, applicable only when server_type is + posix or free_ipa\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"server_type\",\"full_name\":\"auth_source_ldap[server_type]\",\"description\":\"\\n\\u003cp\\u003etype + of the LDAP server\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003efree_ipa\\u003c/code\\u003e, \\u003ccode\\u003eactive_directory\\u003c/code\\u003e, + \\u003ccode\\u003eposix\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ldap_filter\",\"full_name\":\"auth_source_ldap[ldap_filter]\",\"description\":\"\\n\\u003cp\\u003eLDAP + filter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"auth_source_ldap[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"auth_source_ldap[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/auth_source_ldaps/test\",\"name\":\"test\",\"apis\":[{\"api_url\":\"/api/auth_source_ldaps/:id/test\",\"http_method\":\"PUT\",\"short_description\":\"Test + LDAP connection\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/auth_source_ldaps/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/auth_source_ldaps/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + an LDAP authentication source\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"auth_sources\":{\"doc_url\":\"/apidoc/v2/auth_sources\",\"id\":\"auth_sources\",\"api_url\":\"/api\",\"name\":\"Auth_sources\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/auth_sources/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/auth_sources\",\"http_method\":\"GET\",\"short_description\":\"List + all authentication sources\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/auth_sources\",\"http_method\":\"GET\",\"short_description\":\"List + all authentication sources per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/auth_sources\",\"http_method\":\"GET\",\"short_description\":\"List + all authentication sources per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"autosign\":{\"doc_url\":\"/apidoc/v2/autosign\",\"id\":\"autosign\",\"api_url\":\"/api\",\"name\":\"Autosign\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/autosign/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/smart_proxies/:smart_proxy_id/autosign\",\"http_method\":\"GET\",\"short_description\":\"List + all autosign entries\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/autosign/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/smart_proxies/:smart_proxy_id/autosign\",\"http_method\":\"POST\",\"short_description\":\"Create + autosign entry\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eAutosign + entry name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/autosign/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/smart_proxies/:smart_proxy_id/autosign/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + autosign entry\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eAutosign + entry name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"bookmarks\":{\"doc_url\":\"/apidoc/v2/bookmarks\",\"id\":\"bookmarks\",\"api_url\":\"/api\",\"name\":\"Bookmarks\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/bookmarks/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/bookmarks\",\"http_method\":\"GET\",\"short_description\":\"List + all bookmarks\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"controller\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/bookmarks/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/bookmarks/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a bookmark\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/bookmarks/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/bookmarks\",\"http_method\":\"POST\",\"short_description\":\"Create + a bookmark\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"bookmark\",\"full_name\":\"bookmark\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"bookmark[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"controller\",\"full_name\":\"bookmark[controller]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"query\",\"full_name\":\"bookmark[query]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"public\",\"full_name\":\"bookmark[public]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/bookmarks/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/bookmarks/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a bookmark\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"bookmark\",\"full_name\":\"bookmark\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"bookmark[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"controller\",\"full_name\":\"bookmark[controller]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"query\",\"full_name\":\"bookmark[query]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"public\",\"full_name\":\"bookmark[public]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/bookmarks/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/bookmarks/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a bookmark\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"common_parameters\":{\"doc_url\":\"/apidoc/v2/common_parameters\",\"id\":\"common_parameters\",\"api_url\":\"/api\",\"name\":\"Common_parameters\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/common_parameters/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/common_parameters\",\"http_method\":\"GET\",\"short_description\":\"List + all global parameters\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"show_hidden\",\"full_name\":\"show_hidden\",\"description\":\"\\n\\u003cp\\u003eDisplay + hidden values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"domain_name\",\"type\":\"string\"},{\"name\":\"host_group_name\",\"type\":\"string\"},{\"name\":\"host_name\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"key_type\",\"type\":\"string\"},{\"name\":\"location_name\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization_name\",\"type\":\"string\"},{\"name\":\"os_name\",\"type\":\"string\"},{\"name\":\"parameter_type\",\"type\":\"string\"},{\"name\":\"subnet_name\",\"type\":\"text\"},{\"name\":\"type\",\"type\":\"string\"},{\"name\":\"value\",\"type\":\"text\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/common_parameters/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/common_parameters/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a global parameter\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"show_hidden\",\"full_name\":\"show_hidden\",\"description\":\"\\n\\u003cp\\u003eDisplay + hidden values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/common_parameters/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/common_parameters\",\"http_method\":\"POST\",\"short_description\":\"Create + a global parameter\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"common_parameter\",\"full_name\":\"common_parameter\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"common_parameter[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"common_parameter[value]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter_type\",\"full_name\":\"common_parameter[parameter_type]\",\"description\":\"\\n\\u003cp\\u003eType + of value\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"common_parameter[hidden_value]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/common_parameters/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/common_parameters/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a global parameter\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"common_parameter\",\"full_name\":\"common_parameter\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"common_parameter[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"common_parameter[value]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter_type\",\"full_name\":\"common_parameter[parameter_type]\",\"description\":\"\\n\\u003cp\\u003eType + of value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"common_parameter[hidden_value]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/common_parameters/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/common_parameters/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a global parameter\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"compute_attributes\":{\"doc_url\":\"/apidoc/v2/compute_attributes\",\"id\":\"compute_attributes\",\"api_url\":\"/api\",\"name\":\"Compute_attributes\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/compute_attributes/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes\",\"http_method\":\"GET\",\"short_description\":\"List + of compute attributes for provided compute profile and compute resource\",\"deprecated\":null},{\"api_url\":\"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes\",\"http_method\":\"GET\",\"short_description\":\"List + of compute attributes for provided compute profile and compute resource\",\"deprecated\":null},{\"api_url\":\"/api/compute_resources/:compute_resource_id/compute_attributes\",\"http_method\":\"GET\",\"short_description\":\"List + of compute attributes for compute resource\",\"deprecated\":null},{\"api_url\":\"/api/compute_profiles/:compute_profile_id/compute_attributes\",\"http_method\":\"GET\",\"short_description\":\"List + of compute attributes for compute profile\",\"deprecated\":null},{\"api_url\":\"/api/compute_attributes/:id\",\"http_method\":\"GET\",\"short_description\":\"List + of compute attributes\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_profile_id\",\"full_name\":\"compute_profile_id\",\"description\":\"\\n\\u003cp\\u003eID + of compute profile\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"compute_resource_id\",\"description\":\"\\n\\u003cp\\u003eID + of compute_resource\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"compute_profile\",\"type\":\"string\"},{\"name\":\"compute_resource\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_attributes/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_resources/:compute_resource_id/compute_attributes/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_profiles/:compute_profile_id/compute_attributes/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_attributes/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a compute attributes set\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_attributes/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes\",\"http_method\":\"POST\",\"short_description\":\"Create + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes\",\"http_method\":\"POST\",\"short_description\":\"Create + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_resources/:compute_resource_id/compute_attributes\",\"http_method\":\"POST\",\"short_description\":\"Create + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_profiles/:compute_profile_id/compute_attributes\",\"http_method\":\"POST\",\"short_description\":\"Create + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_attributes\",\"http_method\":\"POST\",\"short_description\":\"Create + a compute attributes set\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_profile_id\",\"full_name\":\"compute_profile_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"compute_resource_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_attribute\",\"full_name\":\"compute_attribute\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"vm_attrs\",\"full_name\":\"compute_attribute[vm_attrs]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_attributes/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_resources/:compute_resource_id/compute_attributes/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_profiles/:compute_profile_id/compute_attributes/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a compute attributes set\",\"deprecated\":null},{\"api_url\":\"/api/compute_attributes/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a compute attributes set\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_profile_id\",\"full_name\":\"compute_profile_id\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"compute_resource_id\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_attribute\",\"full_name\":\"compute_attribute\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"vm_attrs\",\"full_name\":\"compute_attribute[vm_attrs]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"compute_profiles\":{\"doc_url\":\"/apidoc/v2/compute_profiles\",\"id\":\"compute_profiles\",\"api_url\":\"/api\",\"name\":\"Compute_profiles\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/compute_profiles/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/compute_profiles\",\"http_method\":\"GET\",\"short_description\":\"List + of compute profiles\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_profiles/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/compute_profiles/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a compute profile\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_profiles/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/compute_profiles\",\"http_method\":\"POST\",\"short_description\":\"Create + a compute profile\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_profile\",\"full_name\":\"compute_profile\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"compute_profile[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_profiles/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/compute_profiles/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a compute profile\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_profile\",\"full_name\":\"compute_profile\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"compute_profile[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/compute_profiles/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/compute_profiles/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a compute profile\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"config_reports\":{\"doc_url\":\"/apidoc/v2/config_reports\",\"id\":\"config_reports\",\"api_url\":\"/api\",\"name\":\"Config_reports\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/config_reports/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/config_reports\",\"http_method\":\"GET\",\"short_description\":\"List + all reports\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"applied\",\"type\":\"integer\"},{\"name\":\"eventful\",\"values\":[\"true\",\"false\"]},{\"name\":\"failed\",\"type\":\"integer\"},{\"name\":\"failed_restarts\",\"type\":\"integer\"},{\"name\":\"host\",\"type\":\"string\"},{\"name\":\"host_id\",\"type\":\"integer\"},{\"name\":\"host_owner_id\",\"type\":\"integer\"},{\"name\":\"hostgroup\",\"type\":\"string\"},{\"name\":\"hostgroup_fullname\",\"type\":\"string\"},{\"name\":\"hostgroup_title\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"last_report\",\"type\":\"datetime\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"log\",\"type\":\"text\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"origin\",\"type\":\"string\"},{\"name\":\"pending\",\"type\":\"integer\"},{\"name\":\"reported\",\"type\":\"datetime\"},{\"name\":\"resource\",\"type\":\"text\"},{\"name\":\"restarted\",\"type\":\"integer\"},{\"name\":\"skipped\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/config_reports/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/config_reports/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/config_reports/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/config_reports\",\"http_method\":\"POST\",\"short_description\":\"Create + a report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"config_report\",\"full_name\":\"config_report\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"host\",\"full_name\":\"config_report[host]\",\"description\":\"\\n\\u003cp\\u003eHostname + or certname\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"reported_at\",\"full_name\":\"config_report[reported_at]\",\"description\":\"\\n\\u003cp\\u003eUTC + time of report\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"status\",\"full_name\":\"config_report[status]\",\"description\":\"\\n\\u003cp\\u003eHash + of status type totals\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"metrics\",\"full_name\":\"config_report[metrics]\",\"description\":\"\\n\\u003cp\\u003eHash + of report metrics, can be just {}\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"logs\",\"full_name\":\"config_report[logs]\",\"description\":\"\\n\\u003cp\\u003eOptional + array of log hashes\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/config_reports/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/config_reports/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/config_reports/last\",\"name\":\"last\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/config_reports/last\",\"http_method\":\"GET\",\"short_description\":\"Show + the last report for a host\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"dashboard\":{\"doc_url\":\"/apidoc/v2/dashboard\",\"id\":\"dashboard\",\"api_url\":\"/api\",\"name\":\"Dashboard\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/dashboard/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/dashboard\",\"http_method\":\"GET\",\"short_description\":\"Get + dashboard details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"domains\":{\"doc_url\":\"/apidoc/v2/domains\",\"id\":\"domains\",\"api_url\":\"/api\",\"name\":\"Domains\",\"short_description\":null,\"full_description\":\"\\n\\u003cp\\u003eSatellite + considers a domain and a DNS zone as the same thing. That is, if you are planning + to manage a site where all the machines are of the form \\u003cem\\u003ehostname\\u003c/em\\u003e.\\u003cstrong\\u003esomewhere.com\\u003c/strong\\u003e + then the domain is \\u003cstrong\\u003esomewhere.com\\u003c/strong\\u003e. + This allows Satellite to associate a puppet variable with a domain/site and + automatically append this variable to all external node requests made by machines + at that site.\\u003c/p\\u003e\\n\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/domains/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/domains\",\"http_method\":\"GET\",\"short_description\":\"List + of domains\",\"deprecated\":null},{\"api_url\":\"/api/subnets/:subnet_id/domains\",\"http_method\":\"GET\",\"short_description\":\"List + of domains per subnet\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/domains\",\"http_method\":\"GET\",\"short_description\":\"List + of domains per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/domains\",\"http_method\":\"GET\",\"short_description\":\"List + of domains per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"subnet_id\",\"full_name\":\"subnet_id\",\"description\":\"\\n\\u003cp\\u003eID + of subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"fullname\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"params\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/domains/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/domains/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a domain\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eNumerical + ID or domain name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"show_hidden_parameters\",\"full_name\":\"show_hidden_parameters\",\"description\":\"\\n\\u003cp\\u003eDisplay + hidden parameter values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/domains/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/domains\",\"http_method\":\"POST\",\"short_description\":\"Create + a domain\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eThe + \\u003cstrong\\u003efullname\\u003c/strong\\u003e field is used for human + readability in reports and other pages that refer to domains, and also available + as an external node parameter\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain\",\"full_name\":\"domain\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"domain[name]\",\"description\":\"\\n\\u003cp\\u003eThe + full DNS domain name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"fullname\",\"full_name\":\"domain[fullname]\",\"description\":\"\\n\\u003cp\\u003eDescription + of the domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dns_id\",\"full_name\":\"domain[dns_id]\",\"description\":\"\\n\\u003cp\\u003eDNS + Capsule ID to use within this domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_parameters_attributes\",\"full_name\":\"domain[domain_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eArray + of parameters (name, value)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"domain[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"domain[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/domains/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/domains/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a domain\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain\",\"full_name\":\"domain\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"domain[name]\",\"description\":\"\\n\\u003cp\\u003eThe + full DNS domain name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"fullname\",\"full_name\":\"domain[fullname]\",\"description\":\"\\n\\u003cp\\u003eDescription + of the domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"dns_id\",\"full_name\":\"domain[dns_id]\",\"description\":\"\\n\\u003cp\\u003eDNS + Capsule ID to use within this domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_parameters_attributes\",\"full_name\":\"domain[domain_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eArray + of parameters (name, value)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"domain[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"domain[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/domains/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/domains/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a domain\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"external_usergroups\":{\"doc_url\":\"/apidoc/v2/external_usergroups\",\"id\":\"external_usergroups\",\"api_url\":\"/api\",\"name\":\"External_usergroups\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/external_usergroups/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/usergroups/:usergroup_id/external_usergroups\",\"http_method\":\"GET\",\"short_description\":\"List + all external user groups for user group\",\"deprecated\":null},{\"api_url\":\"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups\",\"http_method\":\"GET\",\"short_description\":\"List + all external user groups for LDAP authentication source\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup_id\",\"full_name\":\"usergroup_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of user group\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/external_usergroups/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/usergroups/:usergroup_id/external_usergroups/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an external user group for user group\",\"deprecated\":null},{\"api_url\":\"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an external user group for LDAP authentication source\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup_id\",\"full_name\":\"usergroup_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of user group\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + or name of external user group\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/external_usergroups/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/usergroups/:usergroup_id/external_usergroups\",\"http_method\":\"POST\",\"short_description\":\"Create + an external user group linked to a user group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup_id\",\"full_name\":\"usergroup_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of user group\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"external_usergroup\",\"full_name\":\"external_usergroup\",\"description\":\"\\n\\u003cp\\u003eExternal + user group information\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"external_usergroup[name]\",\"description\":\"\\n\\u003cp\\u003eExternal + user group name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"auth_source_id\",\"full_name\":\"external_usergroup[auth_source_id]\",\"description\":\"\\n\\u003cp\\u003eID + of linked authentication source\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/external_usergroups/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/usergroups/:usergroup_id/external_usergroups/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + external user group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup_id\",\"full_name\":\"usergroup_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of user group\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + or name of external user group\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"external_usergroup\",\"full_name\":\"external_usergroup\",\"description\":\"\\n\\u003cp\\u003eExternal + user group information\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"external_usergroup[name]\",\"description\":\"\\n\\u003cp\\u003eExternal + user group name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"auth_source_id\",\"full_name\":\"external_usergroup[auth_source_id]\",\"description\":\"\\n\\u003cp\\u003eID + of linked authentication source\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/external_usergroups/refresh\",\"name\":\"refresh\",\"apis\":[{\"api_url\":\"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh\",\"http_method\":\"PUT\",\"short_description\":\"Refresh + external user group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup_id\",\"full_name\":\"usergroup_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of user group\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + or name of external user group\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/external_usergroups/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/usergroups/:usergroup_id/external_usergroups/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + an external user group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup_id\",\"full_name\":\"usergroup_id\",\"description\":\"\\n\\u003cp\\u003eID + or name of user group\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + or name external user group\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"filters\":{\"doc_url\":\"/apidoc/v2/filters\",\"id\":\"filters\",\"api_url\":\"/api\",\"name\":\"Filters\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/filters/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/filters\",\"http_method\":\"GET\",\"short_description\":\"List + all filters\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"limited\",\"values\":[\"true\",\"false\"]},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"override\",\"values\":[\"true\",\"false\"]},{\"name\":\"permission\",\"type\":\"string\"},{\"name\":\"resource\",\"type\":\"string\"},{\"name\":\"role\",\"type\":\"string\"},{\"name\":\"role_id\",\"type\":\"integer\"},{\"name\":\"search\",\"type\":\"text\"},{\"name\":\"unlimited\",\"values\":[\"true\",\"false\"]}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/filters/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/filters/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a filter\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/filters/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/filters\",\"http_method\":\"POST\",\"short_description\":\"Create + a filter\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"filter\",\"full_name\":\"filter\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"role_id\",\"full_name\":\"filter[role_id]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"filter[search]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"override\",\"full_name\":\"filter[override]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"permission_ids\",\"full_name\":\"filter[permission_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"filter[organization_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"filter[location_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/filters/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/filters/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a filter\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"filter\",\"full_name\":\"filter\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"role_id\",\"full_name\":\"filter[role_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"filter[search]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"override\",\"full_name\":\"filter[override]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"permission_ids\",\"full_name\":\"filter[permission_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"filter[organization_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"filter[location_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/filters/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/filters/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a filter\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"home\":{\"doc_url\":\"/apidoc/v2/home\",\"id\":\"home\",\"api_url\":\"/api\",\"name\":\"Home\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/home/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api\",\"http_method\":\"GET\",\"short_description\":\"Show + available API links\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/home/status\",\"name\":\"status\",\"apis\":[{\"api_url\":\"/api/status\",\"http_method\":\"GET\",\"short_description\":\"Show + status\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"host_statuses\":{\"doc_url\":\"/apidoc/v2/host_statuses\",\"id\":\"host_statuses\",\"api_url\":\"/api\",\"name\":\"Host_statuses\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/host_statuses/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/host_statuses\",\"http_method\":\"GET\",\"short_description\":\"List + of host statuses\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"http_proxies\":{\"doc_url\":\"/apidoc/v2/http_proxies\",\"id\":\"http_proxies\",\"api_url\":\"/api\",\"name\":\"Http_proxies\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/http_proxies/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/http_proxies\",\"http_method\":\"GET\",\"short_description\":\"List + of HTTP Proxies\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"url\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/http_proxies/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/http_proxies/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an HTTP Proxy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eIdentifier + of the HTTP Proxy\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/http_proxies/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/http_proxies\",\"http_method\":\"POST\",\"short_description\":\"Create + an HTTP Proxy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy\",\"full_name\":\"http_proxy\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"http_proxy[name]\",\"description\":\"\\n\\u003cp\\u003eThe + HTTP Proxy name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"http_proxy[url]\",\"description\":\"\\n\\u003cp\\u003eURL + of the HTTP Proxy\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"username\",\"full_name\":\"http_proxy[username]\",\"description\":\"\\n\\u003cp\\u003eUsername + used to authenticate with the HTTP Proxy\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"http_proxy[password]\",\"description\":\"\\n\\u003cp\\u003ePassword + used to authenticate with the HTTP Proxy\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"http_proxy[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"http_proxy[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/http_proxies/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/http_proxies/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an HTTP Proxy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"http_proxy\",\"full_name\":\"http_proxy\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"http_proxy[name]\",\"description\":\"\\n\\u003cp\\u003eThe + HTTP Proxy name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"url\",\"full_name\":\"http_proxy[url]\",\"description\":\"\\n\\u003cp\\u003eURL + of the HTTP Proxy\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"username\",\"full_name\":\"http_proxy[username]\",\"description\":\"\\n\\u003cp\\u003eUsername + used to authenticate with the HTTP Proxy\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"http_proxy[password]\",\"description\":\"\\n\\u003cp\\u003ePassword + used to authenticate with the HTTP Proxy\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"http_proxy[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"http_proxy[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/http_proxies/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/http_proxies/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + an HTTP Proxy\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"images\":{\"doc_url\":\"/apidoc/v2/images\",\"id\":\"images\",\"api_url\":\"/api\",\"name\":\"Images\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/images/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/compute_resources/:compute_resource_id/images\",\"http_method\":\"GET\",\"short_description\":\"List + all images for a compute resource\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/images\",\"http_method\":\"GET\",\"short_description\":\"List + all images for operating system\",\"deprecated\":null},{\"api_url\":\"/api/architectures/:architecture_id/images\",\"http_method\":\"GET\",\"short_description\":\"List + all images for architecture\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"compute_resource_id\",\"description\":\"\\n\\u003cp\\u003eID + of compute resource\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_id\",\"full_name\":\"architecture_id\",\"description\":\"\\n\\u003cp\\u003eID + of architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"architecture\",\"type\":\"integer\"},{\"name\":\"compute_resource\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"operatingsystem\",\"type\":\"integer\"},{\"name\":\"user_data\",\"values\":[\"true\",\"false\"]},{\"name\":\"username\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/images/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/compute_resources/:compute_resource_id/images/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an image\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/images/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an image\",\"deprecated\":null},{\"api_url\":\"/api/architectures/:architecture_id/images/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an image\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"compute_resource_id\",\"description\":\"\\n\\u003cp\\u003eID + of compute resource\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_id\",\"full_name\":\"architecture_id\",\"description\":\"\\n\\u003cp\\u003eID + of architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/images/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/compute_resources/:compute_resource_id/images\",\"http_method\":\"POST\",\"short_description\":\"Create + an image\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"compute_resource_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"image\",\"full_name\":\"image\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"image[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"username\",\"full_name\":\"image[username]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"uuid\",\"full_name\":\"image[uuid]\",\"description\":\"\\n\\u003cp\\u003eTemplate + ID in the compute resource\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"image[password]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"image[compute_resource_id]\",\"description\":\"\\n\\u003cp\\u003eID + of compute resource\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_id\",\"full_name\":\"image[architecture_id]\",\"description\":\"\\n\\u003cp\\u003eID + of architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"image[operatingsystem_id]\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_data\",\"full_name\":\"image[user_data]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the image supports user data\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/images/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/compute_resources/:compute_resource_id/images/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an image\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"compute_resource_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"image\",\"full_name\":\"image\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"image[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"username\",\"full_name\":\"image[username]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"uuid\",\"full_name\":\"image[uuid]\",\"description\":\"\\n\\u003cp\\u003eTemplate + ID in the compute resource\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"image[password]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"image[compute_resource_id]\",\"description\":\"\\n\\u003cp\\u003eID + of compute resource\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_id\",\"full_name\":\"image[architecture_id]\",\"description\":\"\\n\\u003cp\\u003eID + of architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"image[operatingsystem_id]\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_data\",\"full_name\":\"image[user_data]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the image supports user data\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/images/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/compute_resources/:compute_resource_id/images/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + an image\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_id\",\"full_name\":\"compute_resource_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"instance_hosts\":{\"doc_url\":\"/apidoc/v2/instance_hosts\",\"id\":\"instance_hosts\",\"api_url\":\"/api\",\"name\":\"Instance_hosts\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/instance_hosts/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/instance_hosts/:host_id\",\"http_method\":\"PUT\",\"short_description\":\"Assign + a host to the Satellite instance\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an identifier, string from 1 to 128 characters containing only alphanumeric + characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing + space.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/instance_hosts/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/instance_hosts\",\"http_method\":\"GET\",\"short_description\":\"List + hosts forming the Satellite instance\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/instance_hosts/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/instance_hosts/:host_id\",\"http_method\":\"DESTROY\",\"short_description\":\"Unassign + a given host from the Satellite instance\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"locations\":{\"doc_url\":\"/apidoc/v2/locations\",\"id\":\"locations\",\"api_url\":\"/api\",\"name\":\"Locations\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/locations/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/locations\",\"http_method\":\"GET\",\"short_description\":\"List + all locations\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"description\",\"type\":\"text\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"title\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/locations/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/locations/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a location\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"show_hidden_parameters\",\"full_name\":\"show_hidden_parameters\",\"description\":\"\\n\\u003cp\\u003eDisplay + hidden parameter values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/locations/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/locations\",\"http_method\":\"POST\",\"short_description\":\"Create + a location\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location\",\"full_name\":\"location\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"location[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"location[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_ids\",\"full_name\":\"location[user_ids]\",\"description\":\"\\n\\u003cp\\u003eUser + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy_ids\",\"full_name\":\"location[smart_proxy_ids]\",\"description\":\"\\n\\u003cp\\u003eCapsule + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_ids\",\"full_name\":\"location[compute_resource_ids]\",\"description\":\"\\n\\u003cp\\u003eCompute + resource IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_ids\",\"full_name\":\"location[medium_ids]\",\"description\":\"\\n\\u003cp\\u003eMedium + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_ids\",\"full_name\":\"location[ptable_ids]\",\"description\":\"\\n\\u003cp\\u003ePartition + template IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_ids\",\"full_name\":\"location[provisioning_template_ids]\",\"description\":\"\\n\\u003cp\\u003eProvisioning + template IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_ids\",\"full_name\":\"location[domain_ids]\",\"description\":\"\\n\\u003cp\\u003eDomain + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_ids\",\"full_name\":\"location[realm_ids]\",\"description\":\"\\n\\u003cp\\u003eRealm + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_ids\",\"full_name\":\"location[hostgroup_ids]\",\"description\":\"\\n\\u003cp\\u003eHost + group IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_ids\",\"full_name\":\"location[environment_ids]\",\"description\":\"\\n\\u003cp\\u003eEnvironment + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_ids\",\"full_name\":\"location[subnet_ids]\",\"description\":\"\\n\\u003cp\\u003eSubnet + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parent_id\",\"full_name\":\"location[parent_id]\",\"description\":\"\\n\\u003cp\\u003eParent + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ignore_types\",\"full_name\":\"location[ignore_types]\",\"description\":\"\\n\\u003cp\\u003eList + of resources types that will be automatically associated\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"location[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eAssociated + organization IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/locations/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/locations/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a location\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location\",\"full_name\":\"location\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"location[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"location[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_ids\",\"full_name\":\"location[user_ids]\",\"description\":\"\\n\\u003cp\\u003eUser + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy_ids\",\"full_name\":\"location[smart_proxy_ids]\",\"description\":\"\\n\\u003cp\\u003eCapsule + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"compute_resource_ids\",\"full_name\":\"location[compute_resource_ids]\",\"description\":\"\\n\\u003cp\\u003eCompute + resource IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_ids\",\"full_name\":\"location[medium_ids]\",\"description\":\"\\n\\u003cp\\u003eMedium + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_ids\",\"full_name\":\"location[ptable_ids]\",\"description\":\"\\n\\u003cp\\u003ePartition + template IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_ids\",\"full_name\":\"location[provisioning_template_ids]\",\"description\":\"\\n\\u003cp\\u003eProvisioning + template IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_ids\",\"full_name\":\"location[domain_ids]\",\"description\":\"\\n\\u003cp\\u003eDomain + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_ids\",\"full_name\":\"location[realm_ids]\",\"description\":\"\\n\\u003cp\\u003eRealm + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_ids\",\"full_name\":\"location[hostgroup_ids]\",\"description\":\"\\n\\u003cp\\u003eHost + group IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"environment_ids\",\"full_name\":\"location[environment_ids]\",\"description\":\"\\n\\u003cp\\u003eEnvironment + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_ids\",\"full_name\":\"location[subnet_ids]\",\"description\":\"\\n\\u003cp\\u003eSubnet + IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parent_id\",\"full_name\":\"location[parent_id]\",\"description\":\"\\n\\u003cp\\u003eParent + ID\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ignore_types\",\"full_name\":\"location[ignore_types]\",\"description\":\"\\n\\u003cp\\u003eList + of resources types that will be automatically associated\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"location[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eAssociated + organization IDs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/locations/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/locations/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a location\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"mail_notifications\":{\"doc_url\":\"/apidoc/v2/mail_notifications\",\"id\":\"mail_notifications\",\"api_url\":\"/api\",\"name\":\"Mail_notifications\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/mail_notifications/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/mail_notifications\",\"http_method\":\"GET\",\"short_description\":\"List + of email notifications\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"description\",\"type\":\"text\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"user\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/mail_notifications/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/mail_notifications/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an email notification\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eNumerical + ID or email notification name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/mail_notifications/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/users/:user_id/mail_notifications\",\"http_method\":\"POST\",\"short_description\":\"Add + an email notification for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mail_notification_id\",\"full_name\":\"mail_notification_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interval\",\"full_name\":\"interval\",\"description\":\"\\n\\u003cp\\u003eMail + notification interval option, e.g. Daily, Weekly or Monthly. Required for + summary notification\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subscription\",\"full_name\":\"subscription\",\"description\":\"\\n\\u003cp\\u003eMail + notification subscription option, e.g. Subscribe, Subscribe to my hosts or + Subscribe to all hosts. Required for host built and config error state\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mail_query\",\"full_name\":\"mail_query\",\"description\":\"\\n\\u003cp\\u003eRelevant + only for audit summary notification\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/mail_notifications/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/users/:user_id/mail_notifications/:mail_notification_id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an email notification for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mail_notification_id\",\"full_name\":\"mail_notification_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"interval\",\"full_name\":\"interval\",\"description\":\"\\n\\u003cp\\u003eMail + notification interval option, e.g. Daily, Weekly or Monthly. Required for + summary notification\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subscription\",\"full_name\":\"subscription\",\"description\":\"\\n\\u003cp\\u003eMail + notification subscription option, e.g. Subscribe, Subscribe to my hosts or + Subscribe to all hosts. Required for host built and config error state\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mail_query\",\"full_name\":\"mail_query\",\"description\":\"\\n\\u003cp\\u003eRelevant + only for audit summary notification\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/mail_notifications/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/users/:user_id/mail_notifications/:mail_notification_id\",\"http_method\":\"DELETE\",\"short_description\":\"Remove + an email notification for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mail_notification_id\",\"full_name\":\"mail_notification_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/mail_notifications/user_mail_notifications\",\"name\":\"user_mail_notifications\",\"apis\":[{\"api_url\":\"/api/users/:user_id/mail_notifications\",\"http_method\":\"GET\",\"short_description\":\"List + all email notifications for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"media\":{\"doc_url\":\"/apidoc/v2/media\",\"id\":\"media\",\"api_url\":\"/api\",\"name\":\"Media\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/media/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/media\",\"http_method\":\"GET\",\"short_description\":\"List + all installation media\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/media\",\"http_method\":\"GET\",\"short_description\":\"List + all media for an operating system\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/media\",\"http_method\":\"GET\",\"short_description\":\"List + all media per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/media\",\"http_method\":\"GET\",\"short_description\":\"List + all media per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"family\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"path\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/media/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/media/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a medium\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/media/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/media\",\"http_method\":\"POST\",\"short_description\":\"Create + a medium\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium\",\"full_name\":\"medium\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"medium[name]\",\"description\":\"\\n\\u003cp\\u003eName + of media\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"path\",\"full_name\":\"medium[path]\",\"description\":\"\\n\\u003cp\\u003eThe + path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\\u003c/p\\u003e\\n\\n\\u003cp\\u003efor + example \\u003ca href=\\\"http://mirror.centos.org/centos/$version/os/$arch\\\"\\u003emirror.centos.org/centos/$version/os/$arch\\u003c/a\\u003e + where $arch will be substituted for the host\\u0026#39;s actual OS architecture + and $version, $major and $minor will be substituted for the version of the + operating system.\\u003c/p\\u003e\\n\\n\\u003cp\\u003eSolaris and Debian media + may also use $release.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"os_family\",\"full_name\":\"medium[os_family]\",\"description\":\"\\n\\u003cp\\u003eOperating + system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, + Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, + VRP, Windows, Xenserver\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_ids\",\"full_name\":\"medium[operatingsystem_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"medium[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"medium[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/media/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/media/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a medium\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium\",\"full_name\":\"medium\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"medium[name]\",\"description\":\"\\n\\u003cp\\u003eName + of media\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"path\",\"full_name\":\"medium[path]\",\"description\":\"\\n\\u003cp\\u003eThe + path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\\u003c/p\\u003e\\n\\n\\u003cp\\u003efor + example \\u003ca href=\\\"http://mirror.centos.org/centos/$version/os/$arch\\\"\\u003emirror.centos.org/centos/$version/os/$arch\\u003c/a\\u003e + where $arch will be substituted for the host\\u0026#39;s actual OS architecture + and $version, $major and $minor will be substituted for the version of the + operating system.\\u003c/p\\u003e\\n\\n\\u003cp\\u003eSolaris and Debian media + may also use $release.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"os_family\",\"full_name\":\"medium[os_family]\",\"description\":\"\\n\\u003cp\\u003eOperating + system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, + Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, + VRP, Windows, Xenserver\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_ids\",\"full_name\":\"medium[operatingsystem_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"medium[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"medium[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/media/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/media/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a medium\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"models\":{\"doc_url\":\"/apidoc/v2/models\",\"id\":\"models\",\"api_url\":\"/api\",\"name\":\"Models\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/models/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/models\",\"http_method\":\"GET\",\"short_description\":\"List + all hardware models\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"hardware_model\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"info\",\"type\":\"text\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"vendor_class\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/models/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/models/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a hardware model\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/models/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/models\",\"http_method\":\"POST\",\"short_description\":\"Create + a hardware model\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"model\",\"full_name\":\"model\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"model[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"info\",\"full_name\":\"model[info]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"vendor_class\",\"full_name\":\"model[vendor_class]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hardware_model\",\"full_name\":\"model[hardware_model]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/models/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/models/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a hardware model\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"model\",\"full_name\":\"model\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"model[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"info\",\"full_name\":\"model[info]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"vendor_class\",\"full_name\":\"model[vendor_class]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hardware_model\",\"full_name\":\"model[hardware_model]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/models/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/models/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a hardware model\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"operatingsystems\":{\"doc_url\":\"/apidoc/v2/operatingsystems\",\"id\":\"operatingsystems\",\"api_url\":\"/api\",\"name\":\"Operating + systems\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/operatingsystems/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/operatingsystems\",\"http_method\":\"GET\",\"short_description\":\"List + all operating systems\",\"deprecated\":null},{\"api_url\":\"/api/architectures/:architecture_id/operatingsystems\",\"http_method\":\"GET\",\"short_description\":\"List + all operating systems for nested architecture\",\"deprecated\":null},{\"api_url\":\"/api/media/:medium_id/operatingsystems\",\"http_method\":\"GET\",\"short_description\":\"List + all operating systems for nested medium\",\"deprecated\":null},{\"api_url\":\"/api/ptables/:ptable_id/operatingsystems\",\"http_method\":\"GET\",\"short_description\":\"List + all operating systems for nested partition table\",\"deprecated\":null},{\"api_url\":\"/api/provisioning_templates/:provisioning_template_id/operatingsystems\",\"http_method\":\"GET\",\"short_description\":\"List + all operating systems for nested provisioning template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_id\",\"full_name\":\"architecture_id\",\"description\":\"\\n\\u003cp\\u003eID + of architecture\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_id\",\"full_name\":\"medium_id\",\"description\":\"\\n\\u003cp\\u003eID + of medium\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_id\",\"full_name\":\"ptable_id\",\"description\":\"\\n\\u003cp\\u003eID + of partition table\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_id\",\"full_name\":\"provisioning_template_id\",\"description\":\"\\n\\u003cp\\u003eID + of template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"os_parameters_attributes\",\"full_name\":\"os_parameters_attributes\",\"description\":\"\\n\\u003cp\\u003eArray + of parameters\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"os_parameters_attributes[name]\",\"description\":\"\\n\\u003cp\\u003eName + of the parameter\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"os_parameters_attributes[value]\",\"description\":\"\\n\\u003cp\\u003eParameter + value\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"architecture\",\"type\":\"string\"},{\"name\":\"description\",\"type\":\"string\"},{\"name\":\"family\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"major\",\"type\":\"string\"},{\"name\":\"medium\",\"type\":\"string\"},{\"name\":\"minor\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"params\",\"type\":\"string\"},{\"name\":\"template\",\"type\":\"string\"},{\"name\":\"title\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/operatingsystems/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/operatingsystems/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an operating system\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"show_hidden_parameters\",\"full_name\":\"show_hidden_parameters\",\"description\":\"\\n\\u003cp\\u003eDisplay + hidden parameter values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/operatingsystems/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/operatingsystems\",\"http_method\":\"POST\",\"short_description\":\"Create + an operating system\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem\",\"full_name\":\"operatingsystem\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"operatingsystem[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A(\\\\S+)\\\\Z/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"major\",\"full_name\":\"operatingsystem[major]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"minor\",\"full_name\":\"operatingsystem[minor]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"operatingsystem[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"family\",\"full_name\":\"operatingsystem[family]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"release_name\",\"full_name\":\"operatingsystem[release_name]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"os_parameters_attributes\",\"full_name\":\"operatingsystem[os_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eArray + of parameters\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"operatingsystem[os_parameters_attributes][name]\",\"description\":\"\\n\\u003cp\\u003eName + of the parameter\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"operatingsystem[os_parameters_attributes][value]\",\"description\":\"\\n\\u003cp\\u003eParameter + value\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"password_hash\",\"full_name\":\"operatingsystem[password_hash]\",\"description\":\"\\n\\u003cp\\u003eRoot + password hash function to use\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eSHA256\\u003c/code\\u003e, \\u003ccode\\u003eSHA512\\u003c/code\\u003e, + \\u003ccode\\u003eBase64\\u003c/code\\u003e, \\u003ccode\\u003eBase64-Windows\\u003c/code\\u003e, + \\u003ccode\\u003eMD5\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_ids\",\"full_name\":\"operatingsystem[architecture_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated architectures\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_ids\",\"full_name\":\"operatingsystem[provisioning_template_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated provisioning templates\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_ids\",\"full_name\":\"operatingsystem[medium_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated media\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_ids\",\"full_name\":\"operatingsystem[ptable_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated partition tables\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/operatingsystems/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/operatingsystems/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + an operating system\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem\",\"full_name\":\"operatingsystem\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"operatingsystem[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A(\\\\S+)\\\\Z/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"major\",\"full_name\":\"operatingsystem[major]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"minor\",\"full_name\":\"operatingsystem[minor]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"operatingsystem[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"family\",\"full_name\":\"operatingsystem[family]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"release_name\",\"full_name\":\"operatingsystem[release_name]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"os_parameters_attributes\",\"full_name\":\"operatingsystem[os_parameters_attributes]\",\"description\":\"\\n\\u003cp\\u003eArray + of parameters\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an Array of nested elements\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"operatingsystem[os_parameters_attributes][name]\",\"description\":\"\\n\\u003cp\\u003eName + of the parameter\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"operatingsystem[os_parameters_attributes][value]\",\"description\":\"\\n\\u003cp\\u003eParameter + value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"password_hash\",\"full_name\":\"operatingsystem[password_hash]\",\"description\":\"\\n\\u003cp\\u003eRoot + password hash function to use\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eSHA256\\u003c/code\\u003e, \\u003ccode\\u003eSHA512\\u003c/code\\u003e, + \\u003ccode\\u003eBase64\\u003c/code\\u003e, \\u003ccode\\u003eBase64-Windows\\u003c/code\\u003e, + \\u003ccode\\u003eMD5\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture_ids\",\"full_name\":\"operatingsystem[architecture_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated architectures\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_ids\",\"full_name\":\"operatingsystem[provisioning_template_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated provisioning templates\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium_ids\",\"full_name\":\"operatingsystem[medium_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated media\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable_ids\",\"full_name\":\"operatingsystem[ptable_ids]\",\"description\":\"\\n\\u003cp\\u003eIDs + of associated partition tables\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/operatingsystems/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/operatingsystems/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + an operating system\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/operatingsystems/bootfiles\",\"name\":\"bootfiles\",\"apis\":[{\"api_url\":\"/api/operatingsystems/:id/bootfiles\",\"http_method\":\"GET\",\"short_description\":\"List + boot files for an operating system\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"medium\",\"full_name\":\"medium\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"architecture\",\"full_name\":\"architecture\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"os_default_templates\":{\"doc_url\":\"/apidoc/v2/os_default_templates\",\"id\":\"os_default_templates\",\"api_url\":\"/api\",\"name\":\"Os_default_templates\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/os_default_templates/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/os_default_templates\",\"http_method\":\"GET\",\"short_description\":\"List + default templates combinations for an operating system\",\"deprecated\":null},{\"api_url\":\"/api/provisioning_templates/:provisioning_template_id/os_default_templates\",\"http_method\":\"GET\",\"short_description\":\"List + operating systems where this template is set as a default\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_id\",\"full_name\":\"provisioning_template_id\",\"description\":\"\\n\\u003cp\\u003eID + of provisioning template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/os_default_templates/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a default template combination for an operating system\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/os_default_templates/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/os_default_templates\",\"http_method\":\"POST\",\"short_description\":\"Create + a default template combination for an operating system\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"os_default_template\",\"full_name\":\"os_default_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"template_kind_id\",\"full_name\":\"os_default_template[template_kind_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_id\",\"full_name\":\"os_default_template[provisioning_template_id]\",\"description\":\"\\n\\u003cp\\u003eID + of provisioning template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/os_default_templates/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a default template combination for an operating system\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"os_default_template\",\"full_name\":\"os_default_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"template_kind_id\",\"full_name\":\"os_default_template[template_kind_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_id\",\"full_name\":\"os_default_template[provisioning_template_id]\",\"description\":\"\\n\\u003cp\\u003eID + of provisioning template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/os_default_templates/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a default template combination for an operating system\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"parameters\":{\"doc_url\":\"/apidoc/v2/parameters\",\"id\":\"parameters\",\"api_url\":\"/api\",\"name\":\"Parameters\",\"short_description\":null,\"full_description\":\"\\n\\u003cp\\u003eThese + API calls are related to \\u003cstrong\\u003enested parameters for a host, + domain, subnet, host group, operating system\\u003c/strong\\u003e. If you + are looking for \\u0026lt;a href=\u201Ccommon_parameters.html\u201D\\u0026gt;global + parameters\\u0026lt;/a\\u0026gt;, go to \\u0026lt;a href=\u201Ccommon_parameters.html\u201D\\u0026gt;this + link\\u0026lt;/a\\u0026gt;.\\u003c/p\\u003e\\n\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/parameters/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/parameters\",\"http_method\":\"GET\",\"short_description\":\"List + all parameters for a host\",\"deprecated\":null},{\"api_url\":\"/api/hostgroups/:hostgroup_id/parameters\",\"http_method\":\"GET\",\"short_description\":\"List + all parameters for a host group\",\"deprecated\":null},{\"api_url\":\"/api/domains/:domain_id/parameters\",\"http_method\":\"GET\",\"short_description\":\"List + all parameters for a domain\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/parameters\",\"http_method\":\"GET\",\"short_description\":\"List + all parameters for an operating system\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/parameters\",\"http_method\":\"GET\",\"short_description\":\"List + all parameters for a location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/parameters\",\"http_method\":\"GET\",\"short_description\":\"List + all parameters for an organization\",\"deprecated\":null},{\"api_url\":\"/api/subnets/:subnet_id/parameters\",\"http_method\":\"GET\",\"short_description\":\"List + all parameters for a subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + of host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"domain_id\",\"description\":\"\\n\\u003cp\\u003eID + of domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eID + of location\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of organization\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"subnet_id\",\"description\":\"\\n\\u003cp\\u003eID + of subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"show_hidden\",\"full_name\":\"show_hidden\",\"description\":\"\\n\\u003cp\\u003eDisplay + hidden values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"domain_name\",\"type\":\"string\"},{\"name\":\"host_group_name\",\"type\":\"string\"},{\"name\":\"host_name\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"key_type\",\"type\":\"string\"},{\"name\":\"location_name\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization_name\",\"type\":\"string\"},{\"name\":\"os_name\",\"type\":\"string\"},{\"name\":\"parameter_type\",\"type\":\"string\"},{\"name\":\"subnet_name\",\"type\":\"text\"},{\"name\":\"type\",\"type\":\"string\"},{\"name\":\"value\",\"type\":\"text\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/parameters/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/parameters/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a nested parameter for a host\",\"deprecated\":null},{\"api_url\":\"/api/hostgroups/:hostgroup_id/parameters/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a nested parameter for a host group\",\"deprecated\":null},{\"api_url\":\"/api/domains/:domain_id/parameters/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a nested parameter for a domain\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/parameters/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a nested parameter for an operating system\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/parameters/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a nested parameter for a location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/parameters/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a nested parameter for an organization\",\"deprecated\":null},{\"api_url\":\"/api/subnets/:subnet_id/parameters/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a nested parameter for a subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + of host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"domain_id\",\"description\":\"\\n\\u003cp\\u003eID + of domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eID + of location\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of organization\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"subnet_id\",\"description\":\"\\n\\u003cp\\u003eID + of subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of parameter\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"show_hidden\",\"full_name\":\"show_hidden\",\"description\":\"\\n\\u003cp\\u003eDisplay + hidden values\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/parameters/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/parameters\",\"http_method\":\"POST\",\"short_description\":\"Create + a nested parameter for a host\",\"deprecated\":null},{\"api_url\":\"/api/hostgroups/:hostgroup_id/parameters\",\"http_method\":\"POST\",\"short_description\":\"Create + a nested parameter for a host group\",\"deprecated\":null},{\"api_url\":\"/api/domains/:domain_id/parameters\",\"http_method\":\"POST\",\"short_description\":\"Create + a nested parameter for a domain\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/parameters\",\"http_method\":\"POST\",\"short_description\":\"Create + a nested parameter for an operating system\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/parameters\",\"http_method\":\"POST\",\"short_description\":\"Create + a nested parameter for a location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/parameters\",\"http_method\":\"POST\",\"short_description\":\"Create + a nested parameter for an organization\",\"deprecated\":null},{\"api_url\":\"/api/subnets/:subnet_id/parameters\",\"http_method\":\"POST\",\"short_description\":\"Create + a nested parameter for a subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + of host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"domain_id\",\"description\":\"\\n\\u003cp\\u003eID + of domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eID + of location\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of organization\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"subnet_id\",\"description\":\"\\n\\u003cp\\u003eID + of subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter\",\"full_name\":\"parameter\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"parameter[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"parameter[value]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter_type\",\"full_name\":\"parameter[parameter_type]\",\"description\":\"\\n\\u003cp\\u003eType + of value\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/parameters/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/parameters/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a nested parameter for a host\",\"deprecated\":null},{\"api_url\":\"/api/hostgroups/:hostgroup_id/parameters/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a nested parameter for a host group\",\"deprecated\":null},{\"api_url\":\"/api/domains/:domain_id/parameters/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a nested parameter for a domain\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/parameters/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a nested parameter for an operating system\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/parameters/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a nested parameter for a location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/parameters/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a nested parameter for an organization\",\"deprecated\":null},{\"api_url\":\"/api/subnets/:subnet_id/parameters/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a nested parameter for a subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + of host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"domain_id\",\"description\":\"\\n\\u003cp\\u003eID + of domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eID + of location\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of organization\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of parameter\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"subnet_id\",\"description\":\"\\n\\u003cp\\u003eID + of subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter\",\"full_name\":\"parameter\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"parameter[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"parameter[value]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"parameter_type\",\"full_name\":\"parameter[parameter_type]\",\"description\":\"\\n\\u003cp\\u003eType + of value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003estring\\u003c/code\\u003e, \\u003ccode\\u003eboolean\\u003c/code\\u003e, + \\u003ccode\\u003einteger\\u003c/code\\u003e, \\u003ccode\\u003ereal\\u003c/code\\u003e, + \\u003ccode\\u003earray\\u003c/code\\u003e, \\u003ccode\\u003ehash\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/parameters/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/parameters/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a nested parameter for a host\",\"deprecated\":null},{\"api_url\":\"/api/hostgroups/:hostgroup_id/parameters/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a nested parameter for a host group\",\"deprecated\":null},{\"api_url\":\"/api/domains/:domain_id/parameters/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a nested parameter for a domain\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/parameters/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a nested parameter for an operating system\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/parameters/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a nested parameter for a location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/parameters/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a nested parameter for an organization\",\"deprecated\":null},{\"api_url\":\"/api/subnets/:subnet_id/parameters/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a nested parameter for a subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + of host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"domain_id\",\"description\":\"\\n\\u003cp\\u003eID + of domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eID + of location\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of organization\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eID + of parameter\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"subnet_id\",\"description\":\"\\n\\u003cp\\u003eID + of subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/parameters/reset\",\"name\":\"reset\",\"apis\":[{\"api_url\":\"/api/hosts/:host_id/parameters\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + all nested parameters for a host\",\"deprecated\":null},{\"api_url\":\"/api/hostgroups/:hostgroup_id/parameters\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + all nested parameters for a host group\",\"deprecated\":null},{\"api_url\":\"/api/domains/:domain_id/parameters\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + all nested parameters for a domain\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/parameters\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + all nested parameters for an operating system\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/parameters\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + all nested parameter for a location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/parameters\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + all nested parameter for an organization\",\"deprecated\":null},{\"api_url\":\"/api/subnets/:subnet_id/parameters\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + all nested parameters for a subnet\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\\n\\u003cp\\u003eID + of host\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"domain_id\",\"full_name\":\"domain_id\",\"description\":\"\\n\\u003cp\\u003eID + of domain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eID + of location\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eID + of organization\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"subnet_id\",\"full_name\":\"subnet_id\",\"description\":\"\\n\\u003cp\\u003eID + of subnet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":[],\"deprecated\":false},\"permissions\":{\"doc_url\":\"/apidoc/v2/permissions\",\"id\":\"permissions\",\"api_url\":\"/api\",\"name\":\"Permissions\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/permissions/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/permissions\",\"http_method\":\"GET\",\"short_description\":\"List + all permissions\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"resource_type\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/permissions/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/permissions/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a permission\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/permissions/resource_types\",\"name\":\"resource_types\",\"apis\":[{\"api_url\":\"/api/permissions/resource_types\",\"http_method\":\"GET\",\"short_description\":\"List + available resource types\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"personal_access_tokens\":{\"doc_url\":\"/apidoc/v2/personal_access_tokens\",\"id\":\"personal_access_tokens\",\"api_url\":\"/api\",\"name\":\"Personal_access_tokens\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/personal_access_tokens/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/users/:user_id/personal_access_tokens\",\"http_method\":\"GET\",\"short_description\":\"List + all Personal Access Tokens for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"user_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/personal_access_tokens/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/users/:user_id/personal_access_tokens/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a Personal Access Token for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/personal_access_tokens/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/users/:user_id/personal_access_tokens\",\"http_method\":\"POST\",\"short_description\":\"Create + a Personal Access Token for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"personal_access_token\",\"full_name\":\"personal_access_token\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"personal_access_token[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"expires_at\",\"full_name\":\"personal_access_token[expires_at]\",\"description\":\"\\n\\u003cp\\u003eExpiry + Date\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"DateTime\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/personal_access_tokens/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/users/:user_id/personal_access_tokens/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Revoke + a Personal Access Token for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"plugins\":{\"doc_url\":\"/apidoc/v2/plugins\",\"id\":\"plugins\",\"api_url\":\"/api\",\"name\":\"Plugins\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/plugins/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/plugins\",\"http_method\":\"GET\",\"short_description\":\"List + installed plugins\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"provisioning_templates\":{\"doc_url\":\"/apidoc/v2/provisioning_templates\",\"id\":\"provisioning_templates\",\"api_url\":\"/api\",\"name\":\"Provisioning_templates\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/provisioning_templates/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/provisioning_templates\",\"http_method\":\"GET\",\"short_description\":\"List + provisioning templates\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/provisioning_templates\",\"http_method\":\"GET\",\"short_description\":\"List + provisioning templates per operating system\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/provisioning_templates\",\"http_method\":\"GET\",\"short_description\":\"List + provisioning templates per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/provisioning_templates\",\"http_method\":\"GET\",\"short_description\":\"List + provisioning templates per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"default_template\",\"values\":[\"true\",\"false\"]},{\"name\":\"hostgroup\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"kind\",\"type\":\"string\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"locked\",\"values\":[\"true\",\"false\"]},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"operatingsystem\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"snippet\",\"values\":[\"true\",\"false\"]},{\"name\":\"supported\",\"values\":[\"true\",\"false\"]},{\"name\":\"template\",\"type\":\"text\"},{\"name\":\"vendor\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/provisioning_templates/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/provisioning_templates/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + provisioning template details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/provisioning_templates/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/provisioning_templates\",\"http_method\":\"POST\",\"short_description\":\"Create + a provisioning template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template\",\"full_name\":\"provisioning_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"provisioning_template[name]\",\"description\":\"\\n\\u003cp\\u003etemplate + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"provisioning_template[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"provisioning_template[template]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"snippet\",\"full_name\":\"provisioning_template[snippet]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"audit_comment\",\"full_name\":\"provisioning_template[audit_comment]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_kind_id\",\"full_name\":\"provisioning_template[template_kind_id]\",\"description\":\"\\n\\u003cp\\u003enot + relevant for snippet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_combinations_attributes\",\"full_name\":\"provisioning_template[template_combinations_attributes]\",\"description\":\"\\n\\u003cp\\u003eArray + of template combinations (hostgroup_id, environment_id)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_ids\",\"full_name\":\"provisioning_template[operatingsystem_ids]\",\"description\":\"\\n\\u003cp\\u003eArray + of operating system IDs to associate with the template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locked\",\"full_name\":\"provisioning_template[locked]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is locked for editing\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"provisioning_template[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"provisioning_template[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/provisioning_templates/import\",\"name\":\"import\",\"apis\":[{\"api_url\":\"/api/provisioning_templates/import\",\"http_method\":\"POST\",\"short_description\":\"Import + a provisioning template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template\",\"full_name\":\"provisioning_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"provisioning_template[name]\",\"description\":\"\\n\\u003cp\\u003etemplate + name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"provisioning_template[template]\",\"description\":\"\\n\\u003cp\\u003etemplate + contents including metadata\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"provisioning_template[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"provisioning_template[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"options\",\"full_name\":\"options\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"force\",\"full_name\":\"options[force]\",\"description\":\"\\n\\u003cp\\u003euse + if you want update locked templates\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"associate\",\"full_name\":\"options[associate]\",\"description\":\"\\n\\u003cp\\u003edetermines + when the template should associate objects based on metadata, new means only + when new template is being created, always means both for new and existing + template which is only being updated, never ignores metadata\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003enew\\u003c/code\\u003e, \\u003ccode\\u003ealways\\u003c/code\\u003e, + \\u003ccode\\u003enever\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lock\",\"full_name\":\"options[lock]\",\"description\":\"\\n\\u003cp\\u003elock + imported templates (false by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"options[default]\",\"description\":\"\\n\\u003cp\\u003emakes + the template default meaning it will be automatically associated with newly + created organizations and locations (false by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/provisioning_templates/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/provisioning_templates/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a provisioning template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template\",\"full_name\":\"provisioning_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"provisioning_template[name]\",\"description\":\"\\n\\u003cp\\u003etemplate + name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"provisioning_template[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"provisioning_template[template]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"snippet\",\"full_name\":\"provisioning_template[snippet]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"audit_comment\",\"full_name\":\"provisioning_template[audit_comment]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_kind_id\",\"full_name\":\"provisioning_template[template_kind_id]\",\"description\":\"\\n\\u003cp\\u003enot + relevant for snippet\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_combinations_attributes\",\"full_name\":\"provisioning_template[template_combinations_attributes]\",\"description\":\"\\n\\u003cp\\u003eArray + of template combinations (hostgroup_id, environment_id)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_ids\",\"full_name\":\"provisioning_template[operatingsystem_ids]\",\"description\":\"\\n\\u003cp\\u003eArray + of operating system IDs to associate with the template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locked\",\"full_name\":\"provisioning_template[locked]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is locked for editing\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"provisioning_template[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"provisioning_template[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/provisioning_templates/revision\",\"name\":\"revision\",\"apis\":[{\"api_url\":\"/api/provisioning_templates/revision\",\"http_method\":\"GET\",\"short_description\":null,\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"version\",\"description\":\"\\n\\u003cp\\u003etemplate + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/provisioning_templates/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/provisioning_templates/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a provisioning template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/provisioning_templates/build_pxe_default\",\"name\":\"build_pxe_default\",\"apis\":[{\"api_url\":\"/api/provisioning_templates/build_pxe_default\",\"http_method\":\"POST\",\"short_description\":\"Update + the default PXE menu on all configured TFTP servers\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/provisioning_templates/clone\",\"name\":\"clone\",\"apis\":[{\"api_url\":\"/api/provisioning_templates/:id/clone\",\"http_method\":\"POST\",\"short_description\":\"Clone + a provision template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template\",\"full_name\":\"provisioning_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"provisioning_template[name]\",\"description\":\"\\n\\u003cp\\u003etemplate + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/provisioning_templates/export\",\"name\":\"export\",\"apis\":[{\"api_url\":\"/api/provisioning_templates/:id/export\",\"http_method\":\"GET\",\"short_description\":\"Export + a provisioning template to ERB\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"ptables\":{\"doc_url\":\"/apidoc/v2/ptables\",\"id\":\"ptables\",\"api_url\":\"/api\",\"name\":\"Ptables\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/ptables/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/ptables\",\"http_method\":\"GET\",\"short_description\":\"List + all partition tables\",\"deprecated\":null},{\"api_url\":\"/api/operatingsystems/:operatingsystem_id/ptables\",\"http_method\":\"GET\",\"short_description\":\"List + all partition tables for an operating system\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/ptables\",\"http_method\":\"GET\",\"short_description\":\"List + all partition tables per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/ptables\",\"http_method\":\"GET\",\"short_description\":\"List + all partition tables per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"operatingsystem_id\",\"full_name\":\"operatingsystem_id\",\"description\":\"\\n\\u003cp\\u003eID + of operating system\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"default\",\"values\":[\"true\",\"false\"]},{\"name\":\"family\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"layout\",\"type\":\"text\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"locked\",\"values\":[\"true\",\"false\"]},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"snippet\",\"values\":[\"true\",\"false\"]},{\"name\":\"template\",\"type\":\"text\"},{\"name\":\"vendor\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ptables/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/ptables/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a partition table\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ptables/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/ptables\",\"http_method\":\"POST\",\"short_description\":\"Create + a partition table\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable\",\"full_name\":\"ptable\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"ptable[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"ptable[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"layout\",\"full_name\":\"ptable[layout]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"snippet\",\"full_name\":\"ptable[snippet]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"audit_comment\",\"full_name\":\"ptable[audit_comment]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locked\",\"full_name\":\"ptable[locked]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is locked for editing\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"os_family\",\"full_name\":\"ptable[os_family]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_ids\",\"full_name\":\"ptable[operatingsystem_ids]\",\"description\":\"\\n\\u003cp\\u003eArray + of operating system IDs to associate with the partition table\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"ptable[host_ids]\",\"description\":\"\\n\\u003cp\\u003eArray + of host IDs to associate with the partition table\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_ids\",\"full_name\":\"ptable[hostgroup_ids]\",\"description\":\"\\n\\u003cp\\u003eArray + of host group IDs to associate with the partition table\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"ptable[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"ptable[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ptables/import\",\"name\":\"import\",\"apis\":[{\"api_url\":\"/api/ptables/import\",\"http_method\":\"POST\",\"short_description\":\"Import + a partition table\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable\",\"full_name\":\"ptable\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"ptable[name]\",\"description\":\"\\n\\u003cp\\u003etemplate + name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"ptable[template]\",\"description\":\"\\n\\u003cp\\u003etemplate + contents including metadata\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"ptable[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"ptable[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"options\",\"full_name\":\"options\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"force\",\"full_name\":\"options[force]\",\"description\":\"\\n\\u003cp\\u003euse + if you want update locked templates\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"associate\",\"full_name\":\"options[associate]\",\"description\":\"\\n\\u003cp\\u003edetermines + when the template should associate objects based on metadata, new means only + when new template is being created, always means both for new and existing + template which is only being updated, never ignores metadata\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003enew\\u003c/code\\u003e, \\u003ccode\\u003ealways\\u003c/code\\u003e, + \\u003ccode\\u003enever\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lock\",\"full_name\":\"options[lock]\",\"description\":\"\\n\\u003cp\\u003elock + imported templates (false by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"options[default]\",\"description\":\"\\n\\u003cp\\u003emakes + the template default meaning it will be automatically associated with newly + created organizations and locations (false by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ptables/revision\",\"name\":\"revision\",\"apis\":[{\"api_url\":\"/api/ptables/revision\",\"http_method\":\"GET\",\"short_description\":null,\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"version\",\"description\":\"\\n\\u003cp\\u003etemplate + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ptables/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/ptables/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a partition table\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable\",\"full_name\":\"ptable\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"ptable[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"ptable[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"layout\",\"full_name\":\"ptable[layout]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"snippet\",\"full_name\":\"ptable[snippet]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"audit_comment\",\"full_name\":\"ptable[audit_comment]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locked\",\"full_name\":\"ptable[locked]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is locked for editing\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"os_family\",\"full_name\":\"ptable[os_family]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"operatingsystem_ids\",\"full_name\":\"ptable[operatingsystem_ids]\",\"description\":\"\\n\\u003cp\\u003eArray + of operating system IDs to associate with the partition table\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_ids\",\"full_name\":\"ptable[host_ids]\",\"description\":\"\\n\\u003cp\\u003eArray + of host IDs to associate with the partition table\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_ids\",\"full_name\":\"ptable[hostgroup_ids]\",\"description\":\"\\n\\u003cp\\u003eArray + of host group IDs to associate with the partition table\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"ptable[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"ptable[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ptables/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/ptables/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a partition table\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ptables/clone\",\"name\":\"clone\",\"apis\":[{\"api_url\":\"/api/ptables/:id/clone\",\"http_method\":\"POST\",\"short_description\":\"Clone + a template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ptable\",\"full_name\":\"ptable\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"ptable[name]\",\"description\":\"\\n\\u003cp\\u003etemplate + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ptables/export\",\"name\":\"export\",\"apis\":[{\"api_url\":\"/api/ptables/:id/export\",\"http_method\":\"GET\",\"short_description\":\"Export + a partition template to ERB\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"realms\":{\"doc_url\":\"/apidoc/v2/realms\",\"id\":\"realms\",\"api_url\":\"/api\",\"name\":\"Realms\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/realms/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/realms\",\"http_method\":\"GET\",\"short_description\":\"List + of realms\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"type\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/realms/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/realms/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a realm\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eNumerical + ID or realm name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/realms/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/realms\",\"http_method\":\"POST\",\"short_description\":\"Create + a realm\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eThe + \\u003cstrong\\u003ename\\u003c/strong\\u003e field is used for the name of + the realm.\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm\",\"full_name\":\"realm\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"realm[name]\",\"description\":\"\\n\\u003cp\\u003eThe + realm name, e.g. EXAMPLE.COM\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_proxy_id\",\"full_name\":\"realm[realm_proxy_id]\",\"description\":\"\\n\\u003cp\\u003eCapsule + ID to use within this realm\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_type\",\"full_name\":\"realm[realm_type]\",\"description\":\"\\n\\u003cp\\u003eRealm + type, e.g. Red Hat Identity Management or Active Directory\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"realm[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"realm[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/realms/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/realms/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a realm\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm\",\"full_name\":\"realm\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"realm[name]\",\"description\":\"\\n\\u003cp\\u003eThe + realm name, e.g. EXAMPLE.COM\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_proxy_id\",\"full_name\":\"realm[realm_proxy_id]\",\"description\":\"\\n\\u003cp\\u003eCapsule + ID to use within this realm\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"realm_type\",\"full_name\":\"realm[realm_type]\",\"description\":\"\\n\\u003cp\\u003eRealm + type, e.g. Red Hat Identity Management or Active Directory\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"realm[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"realm[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/realms/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/realms/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a realm\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"report_templates\":{\"doc_url\":\"/apidoc/v2/report_templates\",\"id\":\"report_templates\",\"api_url\":\"/api\",\"name\":\"Report_templates\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/report_templates/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/report_templates\",\"http_method\":\"GET\",\"short_description\":\"List + all report templates\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/report_templates\",\"http_method\":\"GET\",\"short_description\":\"List + all report templates per location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/report_templates\",\"http_method\":\"GET\",\"short_description\":\"List + all report templates per organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"default\",\"values\":[\"true\",\"false\"]},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"locked\",\"values\":[\"true\",\"false\"]},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"snippet\",\"values\":[\"true\",\"false\"]},{\"name\":\"template\",\"type\":\"text\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/report_templates/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/report_templates/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a report template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/report_templates/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/report_templates\",\"http_method\":\"POST\",\"short_description\":\"Create + a report template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"report_template\",\"full_name\":\"report_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"report_template[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"report_template[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"report_template[template]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"snippet\",\"full_name\":\"report_template[snippet]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"audit_comment\",\"full_name\":\"report_template[audit_comment]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locked\",\"full_name\":\"report_template[locked]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is locked for editing\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"report_template[default]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is added automatically to new organizations and locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"report_template[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"report_template[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/report_templates/import\",\"name\":\"import\",\"apis\":[{\"api_url\":\"/api/report_templates/import\",\"http_method\":\"POST\",\"short_description\":\"Import + a report template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"report_template\",\"full_name\":\"report_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"report_template[name]\",\"description\":\"\\n\\u003cp\\u003etemplate + name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"report_template[template]\",\"description\":\"\\n\\u003cp\\u003etemplate + contents including metadata\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"report_template[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"report_template[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]},{\"name\":\"options\",\"full_name\":\"options\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"force\",\"full_name\":\"options[force]\",\"description\":\"\\n\\u003cp\\u003euse + if you want update locked templates\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"associate\",\"full_name\":\"options[associate]\",\"description\":\"\\n\\u003cp\\u003edetermines + when the template should associate objects based on metadata, new means only + when new template is being created, always means both for new and existing + template which is only being updated, never ignores metadata\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003enew\\u003c/code\\u003e, \\u003ccode\\u003ealways\\u003c/code\\u003e, + \\u003ccode\\u003enever\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lock\",\"full_name\":\"options[lock]\",\"description\":\"\\n\\u003cp\\u003elock + imported templates (false by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"options[default]\",\"description\":\"\\n\\u003cp\\u003emakes + the template default meaning it will be automatically associated with newly + created organizations and locations (false by default)\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/report_templates/revision\",\"name\":\"revision\",\"apis\":[{\"api_url\":\"/api/report_templates/revision\",\"http_method\":\"GET\",\"short_description\":null,\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"version\",\"full_name\":\"version\",\"description\":\"\\n\\u003cp\\u003etemplate + version\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/report_templates/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/report_templates/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a report template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"report_template\",\"full_name\":\"report_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"report_template[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"report_template[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template\",\"full_name\":\"report_template[template]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"snippet\",\"full_name\":\"report_template[snippet]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"audit_comment\",\"full_name\":\"report_template[audit_comment]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locked\",\"full_name\":\"report_template[locked]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is locked for editing\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"report_template[default]\",\"description\":\"\\n\\u003cp\\u003eWhether + or not the template is added automatically to new organizations and locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"report_template[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"report_template[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/report_templates/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/report_templates/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a report template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/report_templates/clone\",\"name\":\"clone\",\"apis\":[{\"api_url\":\"/api/report_templates/:id/clone\",\"http_method\":\"POST\",\"short_description\":\"Clone + a template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"report_template\",\"full_name\":\"report_template\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"report_template[name]\",\"description\":\"\\n\\u003cp\\u003etemplate + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/report_templates/export\",\"name\":\"export\",\"apis\":[{\"api_url\":\"/api/report_templates/:id/export\",\"http_method\":\"GET\",\"short_description\":\"Export + a report template to ERB\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/report_templates/generate\",\"name\":\"generate\",\"apis\":[{\"api_url\":\"/api/report_templates/:id/generate\",\"http_method\":\"POST\",\"short_description\":\"Generate + report from a template\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"input_values\",\"full_name\":\"input_values\",\"description\":\"\\n\\u003cp\\u003eHash + of input values where key is the name of input, value is the value for this + input\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"gzip\",\"full_name\":\"gzip\",\"description\":\"\\n\\u003cp\\u003eCompress + the report uzing gzip\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"report_format\",\"full_name\":\"report_format\",\"description\":\"\\n\\u003cp\\u003eReport + format, defaults to \\u0026#39;csv\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ecsv\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ehtml\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/report_templates/schedule_report\",\"name\":\"schedule_report\",\"apis\":[{\"api_url\":\"/api/report_templates/:id/schedule_report\",\"http_method\":\"POST\",\"short_description\":\"Schedule + generating of a report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eThe + reports are generated asynchronously. If mail_to is not given, action returns + an url to get resulting report from (see \\u003cstrong\\u003ereport_data\\u003c/strong\\u003e).\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"input_values\",\"full_name\":\"input_values\",\"description\":\"\\n\\u003cp\\u003eHash + of input values where key is the name of input, value is the value for this + input\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"gzip\",\"full_name\":\"gzip\",\"description\":\"\\n\\u003cp\\u003eCompress + the report using gzip\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mail_to\",\"full_name\":\"mail_to\",\"description\":\"\\n\\u003cp\\u003eIf + set, scheduled report will be delivered via e-mail. Use \\u0026#39;,\\u0026#39; + to separate multiple email addresses.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"generate_at\",\"full_name\":\"generate_at\",\"description\":\"\\n\\u003cp\\u003eUTC + time to generate report at\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"report_format\",\"full_name\":\"report_format\",\"description\":\"\\n\\u003cp\\u003eReport + format, defaults to \\u0026#39;csv\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003ecsv\\u003c/code\\u003e, \\u003ccode\\u003ejson\\u003c/code\\u003e, + \\u003ccode\\u003eyaml\\u003c/code\\u003e, \\u003ccode\\u003ehtml\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[{\"code\":200,\"description\":\"a + successful response\",\"is_array\":false,\"returns_object\":[{\"name\":\"job_id\",\"full_name\":\"job_id\",\"description\":\"\\n\\u003cp\\u003eAn + ID of job, which generates report. To be used with report_data API endpoint + for report data retrieval.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"data_url\",\"full_name\":\"data_url\",\"description\":\"\\n\\u003cp\\u003eAn + url to get resulting report from. This is not available when report is delivered + via e-mail.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false}],\"additional_properties\":false}],\"examples\":[\"POST + /api/report_templates/:id/schedule_report/\\n200\\n{\\n \\\"job_id\\\": UNIQUE-REPORT-GENERATING-JOB-UUID\\n + \ \\\"data_url\\\": \\\"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\\\"\\n}\\n\"],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/report_templates/report_data\",\"name\":\"report_data\",\"apis\":[{\"api_url\":\"/api/report_templates/:id/report_data/:job_id\",\"http_method\":\"GET\",\"short_description\":\"Downloads + a generated report\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eReturns + the report data as a raw response. In case the report hasn\\u0026#39;t been + generated yet, it will return an empty response with http status 204 - NoContent.\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"job_id\",\"full_name\":\"job_id\",\"description\":\"\\n\\u003cp\\u003eID + assigned to generating job by the schedule command\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"roles\":{\"doc_url\":\"/apidoc/v2/roles\",\"id\":\"roles\",\"api_url\":\"/api\",\"name\":\"Roles\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/roles/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/roles\",\"http_method\":\"GET\",\"short_description\":\"List + all roles\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"builtin\",\"values\":[\"true\",\"false\"]},{\"name\":\"description\",\"type\":\"text\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"locked\",\"values\":[\"true\",\"false\"]},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"permission\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/roles/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/roles/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a role\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/roles/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/roles\",\"http_method\":\"POST\",\"short_description\":\"Create + a role\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"role\",\"full_name\":\"role\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"role[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"role[description]\",\"description\":\"\\n\\u003cp\\u003eRole + description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"role[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"role[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/roles/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/roles/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a role\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"role\",\"full_name\":\"role\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"role[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"role[description]\",\"description\":\"\\n\\u003cp\\u003eRole + description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"role[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"role[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/roles/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/roles/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a role\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/roles/clone\",\"name\":\"clone\",\"apis\":[{\"api_url\":\"/api/roles/:id/clone\",\"http_method\":\"POST\",\"short_description\":\"Clone + a role\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"role\",\"full_name\":\"role\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"role[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"role[description]\",\"description\":\"\\n\\u003cp\\u003eRole + description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"role[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"role[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"settings\":{\"doc_url\":\"/apidoc/v2/settings\",\"id\":\"settings\",\"api_url\":\"/api\",\"name\":\"Settings\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/settings/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/settings\",\"http_method\":\"GET\",\"short_description\":\"List + all settings\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[{\"code\":200,\"description\":\"List + of all settings\",\"is_array\":false,\"returns_object\":[{\"name\":\"results\",\"full_name\":\"results\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"deprecated\":false}],\"additional_properties\":false}],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"description\",\"type\":\"\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/settings/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/settings/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a setting\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[{\"code\":200,\"description\":\"Information + about the setting\",\"is_array\":false,\"returns_object\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eAlias + for setting name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eSetting + unique name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"full_name\",\"full_name\":\"full_name\",\"description\":\"\\n\\u003cp\\u003eSetting + full user readable name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"category\",\"full_name\":\"category\",\"description\":\"\\n\\u003cp\\u003eThe + category of setting\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"category_name\",\"full_name\":\"category_name\",\"description\":\"\\n\\u003cp\\u003eThe + human readable name of settings category\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"settings_type\",\"full_name\":\"settings_type\",\"description\":\"\\n\\u003cp\\u003eValue + type, that the setting accepts\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eDescribes + the purpose of the setting\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"default\",\"description\":\"\\n\\u003cp\\u003eDefault + value for the setting\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"value\",\"description\":\"\\n\\u003cp\\u003eSetting + current value. If this setting is encypted, the value will not be returned\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"readonly\",\"full_name\":\"readonly\",\"description\":\"\\n\\u003cp\\u003eIs + this setting readonly?\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"encrypted\",\"full_name\":\"encrypted\",\"description\":\"\\n\\u003cp\\u003eIs + this setting encrypted?\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"config_file\",\"full_name\":\"config_file\",\"description\":\"\\n\\u003cp\\u003eIf + this setting needs to be changed in file, it will have the file path.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"select_values\",\"full_name\":\"select_values\",\"description\":\"\\n\\u003cp\\u003eIf + this setting has list of possible values, this includes the list of the values.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"updated_at\",\"full_name\":\"updated_at\",\"description\":\"\\n\\u003cp\\u003eLast + updated. NOTE: this will be reset to application install time, when setting + is reset to default value.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Time\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false}],\"additional_properties\":false}],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/settings/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/settings/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a setting\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"setting\",\"full_name\":\"setting\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"value\",\"full_name\":\"setting[value]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[{\"code\":200,\"description\":\"Information + about the updated setting\",\"is_array\":false,\"returns_object\":[{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\\n\\u003cp\\u003eAlias + for setting name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eSetting + unique name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"full_name\",\"full_name\":\"full_name\",\"description\":\"\\n\\u003cp\\u003eSetting + full user readable name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"category\",\"full_name\":\"category\",\"description\":\"\\n\\u003cp\\u003eThe + category of setting\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"category_name\",\"full_name\":\"category_name\",\"description\":\"\\n\\u003cp\\u003eThe + human readable name of settings category\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"settings_type\",\"full_name\":\"settings_type\",\"description\":\"\\n\\u003cp\\u003eValue + type, that the setting accepts\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"description\",\"description\":\"\\n\\u003cp\\u003eDescribes + the purpose of the setting\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"default\",\"description\":\"\\n\\u003cp\\u003eDefault + value for the setting\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"value\",\"full_name\":\"value\",\"description\":\"\\n\\u003cp\\u003eSetting + current value. If this setting is encypted, the value will not be returned\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"readonly\",\"full_name\":\"readonly\",\"description\":\"\\n\\u003cp\\u003eIs + this setting readonly?\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"encrypted\",\"full_name\":\"encrypted\",\"description\":\"\\n\\u003cp\\u003eIs + this setting encrypted?\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"config_file\",\"full_name\":\"config_file\",\"description\":\"\\n\\u003cp\\u003eIf + this setting needs to be changed in file, it will have the file path.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"select_values\",\"full_name\":\"select_values\",\"description\":\"\\n\\u003cp\\u003eIf + this setting has list of possible values, this includes the list of the values.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"deprecated\":false},{\"name\":\"updated_at\",\"full_name\":\"updated_at\",\"description\":\"\\n\\u003cp\\u003eLast + updated. NOTE: this will be reset to application install time, when setting + is reset to default value.\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Time\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"deprecated\":false}],\"additional_properties\":false}],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"smart_proxy_hosts\":{\"doc_url\":\"/apidoc/v2/smart_proxy_hosts\",\"id\":\"smart_proxy_hosts\",\"api_url\":\"/api\",\"name\":\"Smart_proxy_hosts\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/smart_proxy_hosts/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/smart_proxies/:smart_proxy_id/hosts/:host_id\",\"http_method\":\"PUT\",\"short_description\":\"Assign + a host to the capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"smart_proxy_id\",\"full_name\":\"smart_proxy_id\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"host_id\",\"full_name\":\"host_id\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/smart_proxy_hosts/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/smart_proxies/:smart_proxy_id/hosts\",\"http_method\":\"GET\",\"short_description\":\"Get + hosts forming the capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/smart_proxy_hosts/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/smart_proxies/:smart_proxy_id/hosts/:host_id\",\"http_method\":\"DELETE\",\"short_description\":\"Unassign + a given host from the capsule\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"ssh_keys\":{\"doc_url\":\"/apidoc/v2/ssh_keys\",\"id\":\"ssh_keys\",\"api_url\":\"/api\",\"name\":\"Ssh_keys\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/ssh_keys/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/users/:user_id/ssh_keys\",\"http_method\":\"GET\",\"short_description\":\"List + all SSH keys for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"user_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ssh_keys/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/users/:user_id/ssh_keys/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + an SSH key from a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ssh_keys/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/users/:user_id/ssh_keys\",\"http_method\":\"POST\",\"short_description\":\"Add + an SSH key for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"ssh_key\",\"full_name\":\"ssh_key\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"ssh_key[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"key\",\"full_name\":\"ssh_key[key]\",\"description\":\"\\n\\u003cp\\u003ePublic + SSH key\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/ssh_keys/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/users/:user_id/ssh_keys/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + an SSH key for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"table_preferences\":{\"doc_url\":\"/apidoc/v2/table_preferences\",\"id\":\"table_preferences\",\"api_url\":\"/api\",\"name\":\"Table_preferences\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/table_preferences/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/users/:user_id/table_preferences\",\"http_method\":\"GET\",\"short_description\":\"List + of table preferences for a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/table_preferences/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/users/:user_id/table_preferences/:name\",\"http_method\":\"GET\",\"short_description\":\"Table + preference details of a given table\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the table\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/table_preferences/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/users/:user_id/table_preferences\",\"http_method\":\"POST\",\"short_description\":\"Creates + a table preference for a given table\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the table\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"columns\",\"full_name\":\"columns\",\"description\":\"\\n\\u003cp\\u003eList + of user selected columns\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/table_preferences/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/users/:user_id/table_preferences/:name\",\"http_method\":\"PUT\",\"short_description\":\"Updates + a table preference for a given table\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the table\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"columns\",\"full_name\":\"columns\",\"description\":\"\\n\\u003cp\\u003eList + of user selected columns\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/table_preferences/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/users/:user_id/table_preferences/:name\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a table preference for a given table\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_id\",\"full_name\":\"user_id\",\"description\":\"\\n\\u003cp\\u003eID + of the user\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"name\",\"full_name\":\"name\",\"description\":\"\\n\\u003cp\\u003eName + of the table\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"tasks\":{\"doc_url\":\"/apidoc/v2/tasks\",\"id\":\"tasks\",\"api_url\":\"/api\",\"name\":\"Tasks\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/tasks/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/orchestration/:id/tasks\",\"http_method\":\"GET\",\"short_description\":\"List + all tasks for a given orchestration event\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"template_combinations\":{\"doc_url\":\"/apidoc/v2/template_combinations\",\"id\":\"template_combinations\",\"api_url\":\"/api\",\"name\":\"Template_combinations\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/template_combinations/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/provisioning_templates/:provisioning_template_id/template_combinations\",\"http_method\":\"GET\",\"short_description\":\"List + template combination\",\"deprecated\":null},{\"api_url\":\"/api/hostgroups/:hostgroup_id/template_combinations\",\"http_method\":\"GET\",\"short_description\":\"List + template combination\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_id\",\"full_name\":\"provisioning_template_id\",\"description\":\"\\n\\u003cp\\u003eID + of config template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/template_combinations/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/provisioning_templates/:provisioning_template_id/template_combinations\",\"http_method\":\"POST\",\"short_description\":\"Add + a template combination\",\"deprecated\":null},{\"api_url\":\"/api/hostgroups/:hostgroup_id/template_combinations\",\"http_method\":\"POST\",\"short_description\":\"Add + a template combination\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_id\",\"full_name\":\"provisioning_template_id\",\"description\":\"\\n\\u003cp\\u003eID + of config template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_combination\",\"full_name\":\"template_combination\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"hostgroup_id\",\"full_name\":\"template_combination[hostgroup_id]\",\"description\":\"\\n\\u003cp\\u003ehost + group id\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/template_combinations/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/template_combinations/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + template combination\",\"deprecated\":null},{\"api_url\":\"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + template combination\",\"deprecated\":null},{\"api_url\":\"/api/hostgroups/:hostgroup_id/template_combinations/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + template combination\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_id\",\"full_name\":\"provisioning_template_id\",\"description\":\"\\n\\u003cp\\u003eID + of config template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/template_combinations/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + template combination\",\"deprecated\":null},{\"api_url\":\"/api/hostgroups/:hostgroup_id/template_combinations/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + template combination\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"provisioning_template_id\",\"full_name\":\"provisioning_template_id\",\"description\":\"\\n\\u003cp\\u003eID + of config template\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hostgroup_id\",\"full_name\":\"hostgroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of host group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_combination\",\"full_name\":\"template_combination\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"hostgroup_id\",\"full_name\":\"template_combination[hostgroup_id]\",\"description\":\"\\n\\u003cp\\u003ehost + group id\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/template_combinations/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/template_combinations/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a template combination\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"template_inputs\":{\"doc_url\":\"/apidoc/v2/template_inputs\",\"id\":\"template_inputs\",\"api_url\":\"/api\",\"name\":\"Template_inputs\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/template_inputs/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/templates/:template_id/template_inputs\",\"http_method\":\"GET\",\"short_description\":\"List + template inputs\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"template_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"input_type\",\"type\":\"string\"},{\"name\":\"name\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/template_inputs/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/templates/:template_id/template_inputs/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + template input details\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"template_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/template_inputs/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/templates/:template_id/template_inputs\",\"http_method\":\"POST\",\"short_description\":\"Create + a template input\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"template_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_input\",\"full_name\":\"template_input\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"template_input[name]\",\"description\":\"\\n\\u003cp\\u003eInput + name\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"template_input[description]\",\"description\":\"\\n\\u003cp\\u003eInput + description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"required\",\"full_name\":\"template_input[required]\",\"description\":\"\\n\\u003cp\\u003eInput + is required\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"advanced\",\"full_name\":\"template_input[advanced]\",\"description\":\"\\n\\u003cp\\u003eInput + is advanced\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"input_type\",\"full_name\":\"template_input[input_type]\",\"description\":\"\\n\\u003cp\\u003eInput + type\\u003c/p\\u003e\\n\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003euser\\u003c/code\\u003e, \\u003ccode\\u003efact\\u003c/code\\u003e, + \\u003ccode\\u003evariable\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"fact_name\",\"full_name\":\"template_input[fact_name]\",\"description\":\"\\n\\u003cp\\u003eFact + name, used when input type is Fact value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"variable_name\",\"full_name\":\"template_input[variable_name]\",\"description\":\"\\n\\u003cp\\u003eVariable + name, used when input type is Variable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"options\",\"full_name\":\"template_input[options]\",\"description\":\"\\n\\u003cp\\u003eSelectable + values for user inputs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"template_input[default]\",\"description\":\"\\n\\u003cp\\u003eDefault + value for user input\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"template_input[hidden_value]\",\"description\":\"\\n\\u003cp\\u003eThe + value contains sensitive information and shouldn not be normally visible, + useful e.g. for passwords\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value_type\",\"full_name\":\"template_input[value_type]\",\"description\":\"\\n\\u003cp\\u003eValue + type, defaults to plain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eplain\\u003c/code\\u003e, \\u003ccode\\u003esearch\\u003c/code\\u003e, + \\u003ccode\\u003edate\\u003c/code\\u003e, \\u003ccode\\u003eresource\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"resource_type\",\"full_name\":\"template_input[resource_type]\",\"description\":\"\\n\\u003cp\\u003eFor + values of type search, this is the resource the value searches in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eAnsibleRole\\u003c/code\\u003e, \\u003ccode\\u003eAnsibleVariable\\u003c/code\\u003e, + \\u003ccode\\u003eArchitecture\\u003c/code\\u003e, \\u003ccode\\u003eAudit\\u003c/code\\u003e, + \\u003ccode\\u003eAuthSource\\u003c/code\\u003e, \\u003ccode\\u003eBookmark\\u003c/code\\u003e, + \\u003ccode\\u003eComputeProfile\\u003c/code\\u003e, \\u003ccode\\u003eComputeResource\\u003c/code\\u003e, + \\u003ccode\\u003eConfigReport\\u003c/code\\u003e, \\u003ccode\\u003eDiscoveryRule\\u003c/code\\u003e, + \\u003ccode\\u003eDomain\\u003c/code\\u003e, \\u003ccode\\u003eExternalUsergroup\\u003c/code\\u003e, + \\u003ccode\\u003eFactValue\\u003c/code\\u003e, \\u003ccode\\u003eFilter\\u003c/code\\u003e, + \\u003ccode\\u003eForemanOpenscap::ArfReport\\u003c/code\\u003e, \\u003ccode\\u003eForemanOpenscap::OvalContent\\u003c/code\\u003e, + \\u003ccode\\u003eForemanOpenscap::OvalPolicy\\u003c/code\\u003e, \\u003ccode\\u003eForemanOpenscap::Policy\\u003c/code\\u003e, + \\u003ccode\\u003eForemanOpenscap::ScapContent\\u003c/code\\u003e, \\u003ccode\\u003eForemanOpenscap::TailoringFile\\u003c/code\\u003e, + \\u003ccode\\u003eForemanTasks::RecurringLogic\\u003c/code\\u003e, \\u003ccode\\u003eForemanTasks::Task\\u003c/code\\u003e, + \\u003ccode\\u003eForemanVirtWhoConfigure::Config\\u003c/code\\u003e, \\u003ccode\\u003eHost\\u003c/code\\u003e, + \\u003ccode\\u003eHostgroup\\u003c/code\\u003e, \\u003ccode\\u003eHttpProxy\\u003c/code\\u003e, + \\u003ccode\\u003eImage\\u003c/code\\u003e, \\u003ccode\\u003eInsightsHit\\u003c/code\\u003e, + \\u003ccode\\u003eJobInvocation\\u003c/code\\u003e, \\u003ccode\\u003eJobTemplate\\u003c/code\\u003e, + \\u003ccode\\u003eKatello::ActivationKey\\u003c/code\\u003e, \\u003ccode\\u003eKatello::AlternateContentSource\\u003c/code\\u003e, + \\u003ccode\\u003eKatello::ContentCredential\\u003c/code\\u003e, \\u003ccode\\u003eKatello::ContentView\\u003c/code\\u003e, + \\u003ccode\\u003eKatello::HostCollection\\u003c/code\\u003e, \\u003ccode\\u003eKatello::KTEnvironment\\u003c/code\\u003e, + \\u003ccode\\u003eKatello::Product\\u003c/code\\u003e, \\u003ccode\\u003eKatello::Subscription\\u003c/code\\u003e, + \\u003ccode\\u003eKatello::SyncPlan\\u003c/code\\u003e, \\u003ccode\\u003eKeyPair\\u003c/code\\u003e, + \\u003ccode\\u003eLocation\\u003c/code\\u003e, \\u003ccode\\u003eLookupValue\\u003c/code\\u003e, + \\u003ccode\\u003eMailNotification\\u003c/code\\u003e, \\u003ccode\\u003eMedium\\u003c/code\\u003e, + \\u003ccode\\u003eModel\\u003c/code\\u003e, \\u003ccode\\u003eOperatingsystem\\u003c/code\\u003e, + \\u003ccode\\u003eOrganization\\u003c/code\\u003e, \\u003ccode\\u003eParameter\\u003c/code\\u003e, + \\u003ccode\\u003ePersonalAccessToken\\u003c/code\\u003e, \\u003ccode\\u003eProvisioningTemplate\\u003c/code\\u003e, + \\u003ccode\\u003ePtable\\u003c/code\\u003e, \\u003ccode\\u003eRealm\\u003c/code\\u003e, + \\u003ccode\\u003eRemoteExecutionFeature\\u003c/code\\u003e, \\u003ccode\\u003eReportTemplate\\u003c/code\\u003e, + \\u003ccode\\u003eRole\\u003c/code\\u003e, \\u003ccode\\u003eSetting\\u003c/code\\u003e, + \\u003ccode\\u003eSmartProxy\\u003c/code\\u003e, \\u003ccode\\u003eSshKey\\u003c/code\\u003e, + \\u003ccode\\u003eSubnet\\u003c/code\\u003e, \\u003ccode\\u003eTemplate\\u003c/code\\u003e, + \\u003ccode\\u003eTemplateInvocation\\u003c/code\\u003e, \\u003ccode\\u003eUser\\u003c/code\\u003e, + \\u003ccode\\u003eUsergroup\\u003c/code\\u003e, \\u003ccode\\u003eWebhook\\u003c/code\\u003e, + \\u003ccode\\u003eWebhookTemplate\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/template_inputs/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/templates/:template_id/template_inputs/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a template input\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"template_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/template_inputs/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/templates/:template_id/template_inputs/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a template input\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_id\",\"full_name\":\"template_id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"template_input\",\"full_name\":\"template_input\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"template_input[name]\",\"description\":\"\\n\\u003cp\\u003eInput + name\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"template_input[description]\",\"description\":\"\\n\\u003cp\\u003eInput + description\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"required\",\"full_name\":\"template_input[required]\",\"description\":\"\\n\\u003cp\\u003eInput + is required\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"advanced\",\"full_name\":\"template_input[advanced]\",\"description\":\"\\n\\u003cp\\u003eInput + is advanced\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"input_type\",\"full_name\":\"template_input[input_type]\",\"description\":\"\\n\\u003cp\\u003eInput + type\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003euser\\u003c/code\\u003e, \\u003ccode\\u003efact\\u003c/code\\u003e, + \\u003ccode\\u003evariable\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"fact_name\",\"full_name\":\"template_input[fact_name]\",\"description\":\"\\n\\u003cp\\u003eFact + name, used when input type is Fact value\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"variable_name\",\"full_name\":\"template_input[variable_name]\",\"description\":\"\\n\\u003cp\\u003eVariable + name, used when input type is Variable\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"options\",\"full_name\":\"template_input[options]\",\"description\":\"\\n\\u003cp\\u003eSelectable + values for user inputs\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default\",\"full_name\":\"template_input[default]\",\"description\":\"\\n\\u003cp\\u003eDefault + value for user input\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"hidden_value\",\"full_name\":\"template_input[hidden_value]\",\"description\":\"\\n\\u003cp\\u003eThe + value contains sensitive information and shouldn not be normally visible, + useful e.g. for passwords\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"value_type\",\"full_name\":\"template_input[value_type]\",\"description\":\"\\n\\u003cp\\u003eValue + type, defaults to plain\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eplain\\u003c/code\\u003e, \\u003ccode\\u003esearch\\u003c/code\\u003e, + \\u003ccode\\u003edate\\u003c/code\\u003e, \\u003ccode\\u003eresource\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"resource_type\",\"full_name\":\"template_input[resource_type]\",\"description\":\"\\n\\u003cp\\u003eFor + values of type search, this is the resource the value searches in\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eAnsibleRole\\u003c/code\\u003e, \\u003ccode\\u003eAnsibleVariable\\u003c/code\\u003e, + \\u003ccode\\u003eArchitecture\\u003c/code\\u003e, \\u003ccode\\u003eAudit\\u003c/code\\u003e, + \\u003ccode\\u003eAuthSource\\u003c/code\\u003e, \\u003ccode\\u003eBookmark\\u003c/code\\u003e, + \\u003ccode\\u003eComputeProfile\\u003c/code\\u003e, \\u003ccode\\u003eComputeResource\\u003c/code\\u003e, + \\u003ccode\\u003eConfigReport\\u003c/code\\u003e, \\u003ccode\\u003eDiscoveryRule\\u003c/code\\u003e, + \\u003ccode\\u003eDomain\\u003c/code\\u003e, \\u003ccode\\u003eExternalUsergroup\\u003c/code\\u003e, + \\u003ccode\\u003eFactValue\\u003c/code\\u003e, \\u003ccode\\u003eFilter\\u003c/code\\u003e, + \\u003ccode\\u003eForemanOpenscap::ArfReport\\u003c/code\\u003e, \\u003ccode\\u003eForemanOpenscap::OvalContent\\u003c/code\\u003e, + \\u003ccode\\u003eForemanOpenscap::OvalPolicy\\u003c/code\\u003e, \\u003ccode\\u003eForemanOpenscap::Policy\\u003c/code\\u003e, + \\u003ccode\\u003eForemanOpenscap::ScapContent\\u003c/code\\u003e, \\u003ccode\\u003eForemanOpenscap::TailoringFile\\u003c/code\\u003e, + \\u003ccode\\u003eForemanTasks::RecurringLogic\\u003c/code\\u003e, \\u003ccode\\u003eForemanTasks::Task\\u003c/code\\u003e, + \\u003ccode\\u003eForemanVirtWhoConfigure::Config\\u003c/code\\u003e, \\u003ccode\\u003eHost\\u003c/code\\u003e, + \\u003ccode\\u003eHostgroup\\u003c/code\\u003e, \\u003ccode\\u003eHttpProxy\\u003c/code\\u003e, + \\u003ccode\\u003eImage\\u003c/code\\u003e, \\u003ccode\\u003eInsightsHit\\u003c/code\\u003e, + \\u003ccode\\u003eJobInvocation\\u003c/code\\u003e, \\u003ccode\\u003eJobTemplate\\u003c/code\\u003e, + \\u003ccode\\u003eKatello::ActivationKey\\u003c/code\\u003e, \\u003ccode\\u003eKatello::AlternateContentSource\\u003c/code\\u003e, + \\u003ccode\\u003eKatello::ContentCredential\\u003c/code\\u003e, \\u003ccode\\u003eKatello::ContentView\\u003c/code\\u003e, + \\u003ccode\\u003eKatello::HostCollection\\u003c/code\\u003e, \\u003ccode\\u003eKatello::KTEnvironment\\u003c/code\\u003e, + \\u003ccode\\u003eKatello::Product\\u003c/code\\u003e, \\u003ccode\\u003eKatello::Subscription\\u003c/code\\u003e, + \\u003ccode\\u003eKatello::SyncPlan\\u003c/code\\u003e, \\u003ccode\\u003eKeyPair\\u003c/code\\u003e, + \\u003ccode\\u003eLocation\\u003c/code\\u003e, \\u003ccode\\u003eLookupValue\\u003c/code\\u003e, + \\u003ccode\\u003eMailNotification\\u003c/code\\u003e, \\u003ccode\\u003eMedium\\u003c/code\\u003e, + \\u003ccode\\u003eModel\\u003c/code\\u003e, \\u003ccode\\u003eOperatingsystem\\u003c/code\\u003e, + \\u003ccode\\u003eOrganization\\u003c/code\\u003e, \\u003ccode\\u003eParameter\\u003c/code\\u003e, + \\u003ccode\\u003ePersonalAccessToken\\u003c/code\\u003e, \\u003ccode\\u003eProvisioningTemplate\\u003c/code\\u003e, + \\u003ccode\\u003ePtable\\u003c/code\\u003e, \\u003ccode\\u003eRealm\\u003c/code\\u003e, + \\u003ccode\\u003eRemoteExecutionFeature\\u003c/code\\u003e, \\u003ccode\\u003eReportTemplate\\u003c/code\\u003e, + \\u003ccode\\u003eRole\\u003c/code\\u003e, \\u003ccode\\u003eSetting\\u003c/code\\u003e, + \\u003ccode\\u003eSmartProxy\\u003c/code\\u003e, \\u003ccode\\u003eSshKey\\u003c/code\\u003e, + \\u003ccode\\u003eSubnet\\u003c/code\\u003e, \\u003ccode\\u003eTemplate\\u003c/code\\u003e, + \\u003ccode\\u003eTemplateInvocation\\u003c/code\\u003e, \\u003ccode\\u003eUser\\u003c/code\\u003e, + \\u003ccode\\u003eUsergroup\\u003c/code\\u003e, \\u003ccode\\u003eWebhook\\u003c/code\\u003e, + \\u003ccode\\u003eWebhookTemplate\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"template_kinds\":{\"doc_url\":\"/apidoc/v2/template_kinds\",\"id\":\"template_kinds\",\"api_url\":\"/api\",\"name\":\"Template_kinds\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/template_kinds/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/template_kinds\",\"http_method\":\"GET\",\"short_description\":\"List + all template kinds\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"usergroups\":{\"doc_url\":\"/apidoc/v2/usergroups\",\"id\":\"usergroups\",\"api_url\":\"/api\",\"name\":\"Usergroups\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/usergroups/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/usergroups\",\"http_method\":\"GET\",\"short_description\":\"List + all user groups\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"role\",\"type\":\"string\"},{\"name\":\"role_id\",\"type\":\"integer\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/usergroups/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/usergroups/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a user group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"string + from 2 to 128 characters containing only alphanumeric characters, space, '_', + '-' with no leading or trailing space..\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/usergroups/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/usergroups\",\"http_method\":\"POST\",\"short_description\":\"Create + a user group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup\",\"full_name\":\"usergroup\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"usergroup[name]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"admin\",\"full_name\":\"usergroup[admin]\",\"description\":\"\\n\\u003cp\\u003eis + an admin user group, can be modified by admins only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_ids\",\"full_name\":\"usergroup[user_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup_ids\",\"full_name\":\"usergroup[usergroup_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"role_ids\",\"full_name\":\"usergroup[role_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/usergroups/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/usergroups/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a user group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eUser + groups linked to external groups (LDAP) are automatically synced with these + groups on update. Remember this synchronization will remove any LDAP users + manually added to the Satellite user group. Only LDAP users in the external + groups will remain. Internal users can be added or removed freely.\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup\",\"full_name\":\"usergroup\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"name\",\"full_name\":\"usergroup[name]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"admin\",\"full_name\":\"usergroup[admin]\",\"description\":\"\\n\\u003cp\\u003eis + an admin user group, can be modified by admins only\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user_ids\",\"full_name\":\"usergroup[user_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup_ids\",\"full_name\":\"usergroup[usergroup_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"role_ids\",\"full_name\":\"usergroup[role_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/usergroups/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/usergroups/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a user group\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null},\"users\":{\"doc_url\":\"/apidoc/v2/users\",\"id\":\"users\",\"api_url\":\"/api\",\"name\":\"Users\",\"short_description\":null,\"full_description\":\"\",\"version\":\"v2\",\"formats\":null,\"metadata\":null,\"methods\":[{\"doc_url\":\"/apidoc/v2/users/index\",\"name\":\"index\",\"apis\":[{\"api_url\":\"/api/users\",\"http_method\":\"GET\",\"short_description\":\"List + all users\",\"deprecated\":null},{\"api_url\":\"/api/auth_source_ldaps/:auth_source_ldap_id/users\",\"http_method\":\"GET\",\"short_description\":\"List + all users for LDAP authentication source\",\"deprecated\":null},{\"api_url\":\"/api/auth_source_externals/:auth_source_external_id/users\",\"http_method\":\"GET\",\"short_description\":\"List + all users for external authentication source\",\"deprecated\":null},{\"api_url\":\"/api/usergroups/:usergroup_id/users\",\"http_method\":\"GET\",\"short_description\":\"List + all users for user group\",\"deprecated\":null},{\"api_url\":\"/api/roles/:role_id/users\",\"http_method\":\"GET\",\"short_description\":\"List + all users for role\",\"deprecated\":null},{\"api_url\":\"/api/locations/:location_id/users\",\"http_method\":\"GET\",\"short_description\":\"List + all users for location\",\"deprecated\":null},{\"api_url\":\"/api/organizations/:organization_id/users\",\"http_method\":\"GET\",\"short_description\":\"List + all users for organization\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"auth_source_ldap_id\",\"full_name\":\"auth_source_ldap_id\",\"description\":\"\\n\\u003cp\\u003eID + of LDAP authentication source\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"usergroup_id\",\"full_name\":\"usergroup_id\",\"description\":\"\\n\\u003cp\\u003eID + of user group\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"role_id\",\"full_name\":\"role_id\",\"description\":\"\\n\\u003cp\\u003eID + of role\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eScope + by locations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eScope + by organizations\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"search\",\"full_name\":\"search\",\"description\":\"\\n\\u003cp\\u003efilter + results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"order\",\"full_name\":\"order\",\"description\":\"\\n\\u003cp\\u003eSort + and order by a searchable field, e.g. \\u0026#39;\\u0026lt;field\\u0026gt; + DESC\\u0026#39;\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"page\",\"full_name\":\"page\",\"description\":\"\\n\\u003cp\\u003ePage + number, starting at 1\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + be a number.\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"per_page\",\"full_name\":\"per_page\",\"description\":\"\\n\\u003cp\\u003eNumber + of results per page to return, \\u0026#39;all\\u0026#39; to return all results\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Must + match regular expression \\u003ccode\\u003e/\\\\A([1-9]\\\\d*|all)\\\\Z$/\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":{\"search\":[{\"name\":\"admin\",\"values\":[\"true\",\"false\"]},{\"name\":\"auth_source\",\"type\":\"string\"},{\"name\":\"auth_source_type\",\"type\":\"string\"},{\"name\":\"description\",\"type\":\"text\"},{\"name\":\"disabled\",\"values\":[\"true\",\"false\"]},{\"name\":\"firstname\",\"type\":\"string\"},{\"name\":\"id\",\"type\":\"integer\"},{\"name\":\"last_login_on\",\"type\":\"datetime\"},{\"name\":\"lastname\",\"type\":\"string\"},{\"name\":\"location\",\"type\":\"string\"},{\"name\":\"location_id\",\"type\":\"integer\"},{\"name\":\"login\",\"type\":\"string\"},{\"name\":\"mail\",\"type\":\"string\"},{\"name\":\"organization\",\"type\":\"string\"},{\"name\":\"organization_id\",\"type\":\"integer\"},{\"name\":\"role\",\"type\":\"string\"},{\"name\":\"role_id\",\"type\":\"integer\"},{\"name\":\"usergroup\",\"type\":\"string\"}]},\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/users/show\",\"name\":\"show\",\"apis\":[{\"api_url\":\"/api/users/:id\",\"http_method\":\"GET\",\"short_description\":\"Show + a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/users/show_current\",\"name\":\"show_current\",\"apis\":[{\"api_url\":\"/api/current_user\",\"http_method\":\"GET\",\"short_description\":\"Show + the currently logged-in user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/users/create\",\"name\":\"create\",\"apis\":[{\"api_url\":\"/api/users\",\"http_method\":\"POST\",\"short_description\":\"Create + a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eAdds + role \\u0026#39;Default role\\u0026#39; to the user by default\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user\",\"full_name\":\"user\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"login\",\"full_name\":\"user[login]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"firstname\",\"full_name\":\"user[firstname]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lastname\",\"full_name\":\"user[lastname]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mail\",\"full_name\":\"user[mail]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"user[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"disabled\",\"full_name\":\"user[disabled]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"admin\",\"full_name\":\"user[admin]\",\"description\":\"\\n\\u003cp\\u003eis + an admin account\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"user[password]\",\"description\":\"\\n\\u003cp\\u003eRequired + unless user is in an external authentication source\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default_location_id\",\"full_name\":\"user[default_location_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default_organization_id\",\"full_name\":\"user[default_organization_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"auth_source_id\",\"full_name\":\"user[auth_source_id]\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"timezone\",\"full_name\":\"user[timezone]\",\"description\":\"\\n\\u003cp\\u003eUser\\u0026#39;s + timezone\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eInternational Date Line West\\u003c/code\\u003e, + \\u003ccode\\u003eAmerican Samoa\\u003c/code\\u003e, \\u003ccode\\u003eMidway + Island\\u003c/code\\u003e, \\u003ccode\\u003eHawaii\\u003c/code\\u003e, \\u003ccode\\u003eAlaska\\u003c/code\\u003e, + \\u003ccode\\u003ePacific Time (US \\u0026amp; Canada)\\u003c/code\\u003e, + \\u003ccode\\u003eTijuana\\u003c/code\\u003e, \\u003ccode\\u003eArizona\\u003c/code\\u003e, + \\u003ccode\\u003eMazatlan\\u003c/code\\u003e, \\u003ccode\\u003eMountain + Time (US \\u0026amp; Canada)\\u003c/code\\u003e, \\u003ccode\\u003eCentral + America\\u003c/code\\u003e, \\u003ccode\\u003eCentral Time (US \\u0026amp; + Canada)\\u003c/code\\u003e, \\u003ccode\\u003eChihuahua\\u003c/code\\u003e, + \\u003ccode\\u003eGuadalajara\\u003c/code\\u003e, \\u003ccode\\u003eMexico + City\\u003c/code\\u003e, \\u003ccode\\u003eMonterrey\\u003c/code\\u003e, \\u003ccode\\u003eSaskatchewan\\u003c/code\\u003e, + \\u003ccode\\u003eBogota\\u003c/code\\u003e, \\u003ccode\\u003eEastern Time + (US \\u0026amp; Canada)\\u003c/code\\u003e, \\u003ccode\\u003eIndiana (East)\\u003c/code\\u003e, + \\u003ccode\\u003eLima\\u003c/code\\u003e, \\u003ccode\\u003eQuito\\u003c/code\\u003e, + \\u003ccode\\u003eAtlantic Time (Canada)\\u003c/code\\u003e, \\u003ccode\\u003eCaracas\\u003c/code\\u003e, + \\u003ccode\\u003eGeorgetown\\u003c/code\\u003e, \\u003ccode\\u003eLa Paz\\u003c/code\\u003e, + \\u003ccode\\u003ePuerto Rico\\u003c/code\\u003e, \\u003ccode\\u003eSantiago\\u003c/code\\u003e, + \\u003ccode\\u003eNewfoundland\\u003c/code\\u003e, \\u003ccode\\u003eBrasilia\\u003c/code\\u003e, + \\u003ccode\\u003eBuenos Aires\\u003c/code\\u003e, \\u003ccode\\u003eMontevideo\\u003c/code\\u003e, + \\u003ccode\\u003eGreenland\\u003c/code\\u003e, \\u003ccode\\u003eMid-Atlantic\\u003c/code\\u003e, + \\u003ccode\\u003eAzores\\u003c/code\\u003e, \\u003ccode\\u003eCape Verde + Is.\\u003c/code\\u003e, \\u003ccode\\u003eCasablanca\\u003c/code\\u003e, \\u003ccode\\u003eDublin\\u003c/code\\u003e, + \\u003ccode\\u003eEdinburgh\\u003c/code\\u003e, \\u003ccode\\u003eLisbon\\u003c/code\\u003e, + \\u003ccode\\u003eLondon\\u003c/code\\u003e, \\u003ccode\\u003eMonrovia\\u003c/code\\u003e, + \\u003ccode\\u003eUTC\\u003c/code\\u003e, \\u003ccode\\u003eAmsterdam\\u003c/code\\u003e, + \\u003ccode\\u003eBelgrade\\u003c/code\\u003e, \\u003ccode\\u003eBerlin\\u003c/code\\u003e, + \\u003ccode\\u003eBern\\u003c/code\\u003e, \\u003ccode\\u003eBratislava\\u003c/code\\u003e, + \\u003ccode\\u003eBrussels\\u003c/code\\u003e, \\u003ccode\\u003eBudapest\\u003c/code\\u003e, + \\u003ccode\\u003eCopenhagen\\u003c/code\\u003e, \\u003ccode\\u003eLjubljana\\u003c/code\\u003e, + \\u003ccode\\u003eMadrid\\u003c/code\\u003e, \\u003ccode\\u003eParis\\u003c/code\\u003e, + \\u003ccode\\u003ePrague\\u003c/code\\u003e, \\u003ccode\\u003eRome\\u003c/code\\u003e, + \\u003ccode\\u003eSarajevo\\u003c/code\\u003e, \\u003ccode\\u003eSkopje\\u003c/code\\u003e, + \\u003ccode\\u003eStockholm\\u003c/code\\u003e, \\u003ccode\\u003eVienna\\u003c/code\\u003e, + \\u003ccode\\u003eWarsaw\\u003c/code\\u003e, \\u003ccode\\u003eWest Central + Africa\\u003c/code\\u003e, \\u003ccode\\u003eZagreb\\u003c/code\\u003e, \\u003ccode\\u003eZurich\\u003c/code\\u003e, + \\u003ccode\\u003eAthens\\u003c/code\\u003e, \\u003ccode\\u003eBucharest\\u003c/code\\u003e, + \\u003ccode\\u003eCairo\\u003c/code\\u003e, \\u003ccode\\u003eHarare\\u003c/code\\u003e, + \\u003ccode\\u003eHelsinki\\u003c/code\\u003e, \\u003ccode\\u003eJerusalem\\u003c/code\\u003e, + \\u003ccode\\u003eKaliningrad\\u003c/code\\u003e, \\u003ccode\\u003eKyiv\\u003c/code\\u003e, + \\u003ccode\\u003ePretoria\\u003c/code\\u003e, \\u003ccode\\u003eRiga\\u003c/code\\u003e, + \\u003ccode\\u003eSofia\\u003c/code\\u003e, \\u003ccode\\u003eTallinn\\u003c/code\\u003e, + \\u003ccode\\u003eVilnius\\u003c/code\\u003e, \\u003ccode\\u003eBaghdad\\u003c/code\\u003e, + \\u003ccode\\u003eIstanbul\\u003c/code\\u003e, \\u003ccode\\u003eKuwait\\u003c/code\\u003e, + \\u003ccode\\u003eMinsk\\u003c/code\\u003e, \\u003ccode\\u003eMoscow\\u003c/code\\u003e, + \\u003ccode\\u003eNairobi\\u003c/code\\u003e, \\u003ccode\\u003eRiyadh\\u003c/code\\u003e, + \\u003ccode\\u003eSt. Petersburg\\u003c/code\\u003e, \\u003ccode\\u003eVolgograd\\u003c/code\\u003e, + \\u003ccode\\u003eTehran\\u003c/code\\u003e, \\u003ccode\\u003eAbu Dhabi\\u003c/code\\u003e, + \\u003ccode\\u003eBaku\\u003c/code\\u003e, \\u003ccode\\u003eMuscat\\u003c/code\\u003e, + \\u003ccode\\u003eSamara\\u003c/code\\u003e, \\u003ccode\\u003eTbilisi\\u003c/code\\u003e, + \\u003ccode\\u003eYerevan\\u003c/code\\u003e, \\u003ccode\\u003eKabul\\u003c/code\\u003e, + \\u003ccode\\u003eEkaterinburg\\u003c/code\\u003e, \\u003ccode\\u003eIslamabad\\u003c/code\\u003e, + \\u003ccode\\u003eKarachi\\u003c/code\\u003e, \\u003ccode\\u003eTashkent\\u003c/code\\u003e, + \\u003ccode\\u003eChennai\\u003c/code\\u003e, \\u003ccode\\u003eKolkata\\u003c/code\\u003e, + \\u003ccode\\u003eMumbai\\u003c/code\\u003e, \\u003ccode\\u003eNew Delhi\\u003c/code\\u003e, + \\u003ccode\\u003eSri Jayawardenepura\\u003c/code\\u003e, \\u003ccode\\u003eKathmandu\\u003c/code\\u003e, + \\u003ccode\\u003eAlmaty\\u003c/code\\u003e, \\u003ccode\\u003eAstana\\u003c/code\\u003e, + \\u003ccode\\u003eDhaka\\u003c/code\\u003e, \\u003ccode\\u003eUrumqi\\u003c/code\\u003e, + \\u003ccode\\u003eRangoon\\u003c/code\\u003e, \\u003ccode\\u003eBangkok\\u003c/code\\u003e, + \\u003ccode\\u003eHanoi\\u003c/code\\u003e, \\u003ccode\\u003eJakarta\\u003c/code\\u003e, + \\u003ccode\\u003eKrasnoyarsk\\u003c/code\\u003e, \\u003ccode\\u003eNovosibirsk\\u003c/code\\u003e, + \\u003ccode\\u003eBeijing\\u003c/code\\u003e, \\u003ccode\\u003eChongqing\\u003c/code\\u003e, + \\u003ccode\\u003eHong Kong\\u003c/code\\u003e, \\u003ccode\\u003eIrkutsk\\u003c/code\\u003e, + \\u003ccode\\u003eKuala Lumpur\\u003c/code\\u003e, \\u003ccode\\u003ePerth\\u003c/code\\u003e, + \\u003ccode\\u003eSingapore\\u003c/code\\u003e, \\u003ccode\\u003eTaipei\\u003c/code\\u003e, + \\u003ccode\\u003eUlaanbaatar\\u003c/code\\u003e, \\u003ccode\\u003eOsaka\\u003c/code\\u003e, + \\u003ccode\\u003eSapporo\\u003c/code\\u003e, \\u003ccode\\u003eSeoul\\u003c/code\\u003e, + \\u003ccode\\u003eTokyo\\u003c/code\\u003e, \\u003ccode\\u003eYakutsk\\u003c/code\\u003e, + \\u003ccode\\u003eAdelaide\\u003c/code\\u003e, \\u003ccode\\u003eDarwin\\u003c/code\\u003e, + \\u003ccode\\u003eBrisbane\\u003c/code\\u003e, \\u003ccode\\u003eCanberra\\u003c/code\\u003e, + \\u003ccode\\u003eGuam\\u003c/code\\u003e, \\u003ccode\\u003eHobart\\u003c/code\\u003e, + \\u003ccode\\u003eMelbourne\\u003c/code\\u003e, \\u003ccode\\u003ePort Moresby\\u003c/code\\u003e, + \\u003ccode\\u003eSydney\\u003c/code\\u003e, \\u003ccode\\u003eVladivostok\\u003c/code\\u003e, + \\u003ccode\\u003eMagadan\\u003c/code\\u003e, \\u003ccode\\u003eNew Caledonia\\u003c/code\\u003e, + \\u003ccode\\u003eSolomon Is.\\u003c/code\\u003e, \\u003ccode\\u003eSrednekolymsk\\u003c/code\\u003e, + \\u003ccode\\u003eAuckland\\u003c/code\\u003e, \\u003ccode\\u003eFiji\\u003c/code\\u003e, + \\u003ccode\\u003eKamchatka\\u003c/code\\u003e, \\u003ccode\\u003eMarshall + Is.\\u003c/code\\u003e, \\u003ccode\\u003eWellington\\u003c/code\\u003e, \\u003ccode\\u003eChatham + Is.\\u003c/code\\u003e, \\u003ccode\\u003eNuku\\u0026#39;alofa\\u003c/code\\u003e, + \\u003ccode\\u003eSamoa\\u003c/code\\u003e, \\u003ccode\\u003eTokelau Is.\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locale\",\"full_name\":\"user[locale]\",\"description\":\"\\n\\u003cp\\u003eUser\\u0026#39;s + preferred locale\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eca\\u003c/code\\u003e, \\u003ccode\\u003ecs_CZ\\u003c/code\\u003e, + \\u003ccode\\u003ede\\u003c/code\\u003e, \\u003ccode\\u003een\\u003c/code\\u003e, + \\u003ccode\\u003een_GB\\u003c/code\\u003e, \\u003ccode\\u003ees\\u003c/code\\u003e, + \\u003ccode\\u003efr\\u003c/code\\u003e, \\u003ccode\\u003eit\\u003c/code\\u003e, + \\u003ccode\\u003eja\\u003c/code\\u003e, \\u003ccode\\u003eka\\u003c/code\\u003e, + \\u003ccode\\u003eko\\u003c/code\\u003e, \\u003ccode\\u003epl\\u003c/code\\u003e, + \\u003ccode\\u003ept_BR\\u003c/code\\u003e, \\u003ccode\\u003eru\\u003c/code\\u003e, + \\u003ccode\\u003ezh_CN\\u003c/code\\u003e, \\u003ccode\\u003ezh_TW\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"role_ids\",\"full_name\":\"user[role_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mail_enabled\",\"full_name\":\"user[mail_enabled]\",\"description\":\"\\n\\u003cp\\u003eEnable + user\\u0026#39;s email\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"user[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"user[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/users/update\",\"name\":\"update\",\"apis\":[{\"api_url\":\"/api/users/:id\",\"http_method\":\"PUT\",\"short_description\":\"Update + a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\\n\\u003cp\\u003eAdds + role \\u0026#39;Default role\\u0026#39; to the user if it is not already present. + Only another admin can change the admin account attribute.\\u003c/p\\u003e\\n\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"user\",\"full_name\":\"user\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Hash\",\"expected_type\":\"hash\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false,\"params\":[{\"name\":\"login\",\"full_name\":\"user[login]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"firstname\",\"full_name\":\"user[firstname]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"lastname\",\"full_name\":\"user[lastname]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mail\",\"full_name\":\"user[mail]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"description\",\"full_name\":\"user[description]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"disabled\",\"full_name\":\"user[disabled]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"admin\",\"full_name\":\"user[admin]\",\"description\":\"\\n\\u003cp\\u003eis + an admin account\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"password\",\"full_name\":\"user[password]\",\"description\":\"\\n\\u003cp\\u003eRequired + unless user is in an external authentication source\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default_location_id\",\"full_name\":\"user[default_location_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"default_organization_id\",\"full_name\":\"user[default_organization_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"auth_source_id\",\"full_name\":\"user[auth_source_id]\",\"description\":\"\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"timezone\",\"full_name\":\"user[timezone]\",\"description\":\"\\n\\u003cp\\u003eUser\\u0026#39;s + timezone\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eInternational Date Line West\\u003c/code\\u003e, + \\u003ccode\\u003eAmerican Samoa\\u003c/code\\u003e, \\u003ccode\\u003eMidway + Island\\u003c/code\\u003e, \\u003ccode\\u003eHawaii\\u003c/code\\u003e, \\u003ccode\\u003eAlaska\\u003c/code\\u003e, + \\u003ccode\\u003ePacific Time (US \\u0026amp; Canada)\\u003c/code\\u003e, + \\u003ccode\\u003eTijuana\\u003c/code\\u003e, \\u003ccode\\u003eArizona\\u003c/code\\u003e, + \\u003ccode\\u003eMazatlan\\u003c/code\\u003e, \\u003ccode\\u003eMountain + Time (US \\u0026amp; Canada)\\u003c/code\\u003e, \\u003ccode\\u003eCentral + America\\u003c/code\\u003e, \\u003ccode\\u003eCentral Time (US \\u0026amp; + Canada)\\u003c/code\\u003e, \\u003ccode\\u003eChihuahua\\u003c/code\\u003e, + \\u003ccode\\u003eGuadalajara\\u003c/code\\u003e, \\u003ccode\\u003eMexico + City\\u003c/code\\u003e, \\u003ccode\\u003eMonterrey\\u003c/code\\u003e, \\u003ccode\\u003eSaskatchewan\\u003c/code\\u003e, + \\u003ccode\\u003eBogota\\u003c/code\\u003e, \\u003ccode\\u003eEastern Time + (US \\u0026amp; Canada)\\u003c/code\\u003e, \\u003ccode\\u003eIndiana (East)\\u003c/code\\u003e, + \\u003ccode\\u003eLima\\u003c/code\\u003e, \\u003ccode\\u003eQuito\\u003c/code\\u003e, + \\u003ccode\\u003eAtlantic Time (Canada)\\u003c/code\\u003e, \\u003ccode\\u003eCaracas\\u003c/code\\u003e, + \\u003ccode\\u003eGeorgetown\\u003c/code\\u003e, \\u003ccode\\u003eLa Paz\\u003c/code\\u003e, + \\u003ccode\\u003ePuerto Rico\\u003c/code\\u003e, \\u003ccode\\u003eSantiago\\u003c/code\\u003e, + \\u003ccode\\u003eNewfoundland\\u003c/code\\u003e, \\u003ccode\\u003eBrasilia\\u003c/code\\u003e, + \\u003ccode\\u003eBuenos Aires\\u003c/code\\u003e, \\u003ccode\\u003eMontevideo\\u003c/code\\u003e, + \\u003ccode\\u003eGreenland\\u003c/code\\u003e, \\u003ccode\\u003eMid-Atlantic\\u003c/code\\u003e, + \\u003ccode\\u003eAzores\\u003c/code\\u003e, \\u003ccode\\u003eCape Verde + Is.\\u003c/code\\u003e, \\u003ccode\\u003eCasablanca\\u003c/code\\u003e, \\u003ccode\\u003eDublin\\u003c/code\\u003e, + \\u003ccode\\u003eEdinburgh\\u003c/code\\u003e, \\u003ccode\\u003eLisbon\\u003c/code\\u003e, + \\u003ccode\\u003eLondon\\u003c/code\\u003e, \\u003ccode\\u003eMonrovia\\u003c/code\\u003e, + \\u003ccode\\u003eUTC\\u003c/code\\u003e, \\u003ccode\\u003eAmsterdam\\u003c/code\\u003e, + \\u003ccode\\u003eBelgrade\\u003c/code\\u003e, \\u003ccode\\u003eBerlin\\u003c/code\\u003e, + \\u003ccode\\u003eBern\\u003c/code\\u003e, \\u003ccode\\u003eBratislava\\u003c/code\\u003e, + \\u003ccode\\u003eBrussels\\u003c/code\\u003e, \\u003ccode\\u003eBudapest\\u003c/code\\u003e, + \\u003ccode\\u003eCopenhagen\\u003c/code\\u003e, \\u003ccode\\u003eLjubljana\\u003c/code\\u003e, + \\u003ccode\\u003eMadrid\\u003c/code\\u003e, \\u003ccode\\u003eParis\\u003c/code\\u003e, + \\u003ccode\\u003ePrague\\u003c/code\\u003e, \\u003ccode\\u003eRome\\u003c/code\\u003e, + \\u003ccode\\u003eSarajevo\\u003c/code\\u003e, \\u003ccode\\u003eSkopje\\u003c/code\\u003e, + \\u003ccode\\u003eStockholm\\u003c/code\\u003e, \\u003ccode\\u003eVienna\\u003c/code\\u003e, + \\u003ccode\\u003eWarsaw\\u003c/code\\u003e, \\u003ccode\\u003eWest Central + Africa\\u003c/code\\u003e, \\u003ccode\\u003eZagreb\\u003c/code\\u003e, \\u003ccode\\u003eZurich\\u003c/code\\u003e, + \\u003ccode\\u003eAthens\\u003c/code\\u003e, \\u003ccode\\u003eBucharest\\u003c/code\\u003e, + \\u003ccode\\u003eCairo\\u003c/code\\u003e, \\u003ccode\\u003eHarare\\u003c/code\\u003e, + \\u003ccode\\u003eHelsinki\\u003c/code\\u003e, \\u003ccode\\u003eJerusalem\\u003c/code\\u003e, + \\u003ccode\\u003eKaliningrad\\u003c/code\\u003e, \\u003ccode\\u003eKyiv\\u003c/code\\u003e, + \\u003ccode\\u003ePretoria\\u003c/code\\u003e, \\u003ccode\\u003eRiga\\u003c/code\\u003e, + \\u003ccode\\u003eSofia\\u003c/code\\u003e, \\u003ccode\\u003eTallinn\\u003c/code\\u003e, + \\u003ccode\\u003eVilnius\\u003c/code\\u003e, \\u003ccode\\u003eBaghdad\\u003c/code\\u003e, + \\u003ccode\\u003eIstanbul\\u003c/code\\u003e, \\u003ccode\\u003eKuwait\\u003c/code\\u003e, + \\u003ccode\\u003eMinsk\\u003c/code\\u003e, \\u003ccode\\u003eMoscow\\u003c/code\\u003e, + \\u003ccode\\u003eNairobi\\u003c/code\\u003e, \\u003ccode\\u003eRiyadh\\u003c/code\\u003e, + \\u003ccode\\u003eSt. Petersburg\\u003c/code\\u003e, \\u003ccode\\u003eVolgograd\\u003c/code\\u003e, + \\u003ccode\\u003eTehran\\u003c/code\\u003e, \\u003ccode\\u003eAbu Dhabi\\u003c/code\\u003e, + \\u003ccode\\u003eBaku\\u003c/code\\u003e, \\u003ccode\\u003eMuscat\\u003c/code\\u003e, + \\u003ccode\\u003eSamara\\u003c/code\\u003e, \\u003ccode\\u003eTbilisi\\u003c/code\\u003e, + \\u003ccode\\u003eYerevan\\u003c/code\\u003e, \\u003ccode\\u003eKabul\\u003c/code\\u003e, + \\u003ccode\\u003eEkaterinburg\\u003c/code\\u003e, \\u003ccode\\u003eIslamabad\\u003c/code\\u003e, + \\u003ccode\\u003eKarachi\\u003c/code\\u003e, \\u003ccode\\u003eTashkent\\u003c/code\\u003e, + \\u003ccode\\u003eChennai\\u003c/code\\u003e, \\u003ccode\\u003eKolkata\\u003c/code\\u003e, + \\u003ccode\\u003eMumbai\\u003c/code\\u003e, \\u003ccode\\u003eNew Delhi\\u003c/code\\u003e, + \\u003ccode\\u003eSri Jayawardenepura\\u003c/code\\u003e, \\u003ccode\\u003eKathmandu\\u003c/code\\u003e, + \\u003ccode\\u003eAlmaty\\u003c/code\\u003e, \\u003ccode\\u003eAstana\\u003c/code\\u003e, + \\u003ccode\\u003eDhaka\\u003c/code\\u003e, \\u003ccode\\u003eUrumqi\\u003c/code\\u003e, + \\u003ccode\\u003eRangoon\\u003c/code\\u003e, \\u003ccode\\u003eBangkok\\u003c/code\\u003e, + \\u003ccode\\u003eHanoi\\u003c/code\\u003e, \\u003ccode\\u003eJakarta\\u003c/code\\u003e, + \\u003ccode\\u003eKrasnoyarsk\\u003c/code\\u003e, \\u003ccode\\u003eNovosibirsk\\u003c/code\\u003e, + \\u003ccode\\u003eBeijing\\u003c/code\\u003e, \\u003ccode\\u003eChongqing\\u003c/code\\u003e, + \\u003ccode\\u003eHong Kong\\u003c/code\\u003e, \\u003ccode\\u003eIrkutsk\\u003c/code\\u003e, + \\u003ccode\\u003eKuala Lumpur\\u003c/code\\u003e, \\u003ccode\\u003ePerth\\u003c/code\\u003e, + \\u003ccode\\u003eSingapore\\u003c/code\\u003e, \\u003ccode\\u003eTaipei\\u003c/code\\u003e, + \\u003ccode\\u003eUlaanbaatar\\u003c/code\\u003e, \\u003ccode\\u003eOsaka\\u003c/code\\u003e, + \\u003ccode\\u003eSapporo\\u003c/code\\u003e, \\u003ccode\\u003eSeoul\\u003c/code\\u003e, + \\u003ccode\\u003eTokyo\\u003c/code\\u003e, \\u003ccode\\u003eYakutsk\\u003c/code\\u003e, + \\u003ccode\\u003eAdelaide\\u003c/code\\u003e, \\u003ccode\\u003eDarwin\\u003c/code\\u003e, + \\u003ccode\\u003eBrisbane\\u003c/code\\u003e, \\u003ccode\\u003eCanberra\\u003c/code\\u003e, + \\u003ccode\\u003eGuam\\u003c/code\\u003e, \\u003ccode\\u003eHobart\\u003c/code\\u003e, + \\u003ccode\\u003eMelbourne\\u003c/code\\u003e, \\u003ccode\\u003ePort Moresby\\u003c/code\\u003e, + \\u003ccode\\u003eSydney\\u003c/code\\u003e, \\u003ccode\\u003eVladivostok\\u003c/code\\u003e, + \\u003ccode\\u003eMagadan\\u003c/code\\u003e, \\u003ccode\\u003eNew Caledonia\\u003c/code\\u003e, + \\u003ccode\\u003eSolomon Is.\\u003c/code\\u003e, \\u003ccode\\u003eSrednekolymsk\\u003c/code\\u003e, + \\u003ccode\\u003eAuckland\\u003c/code\\u003e, \\u003ccode\\u003eFiji\\u003c/code\\u003e, + \\u003ccode\\u003eKamchatka\\u003c/code\\u003e, \\u003ccode\\u003eMarshall + Is.\\u003c/code\\u003e, \\u003ccode\\u003eWellington\\u003c/code\\u003e, \\u003ccode\\u003eChatham + Is.\\u003c/code\\u003e, \\u003ccode\\u003eNuku\\u0026#39;alofa\\u003c/code\\u003e, + \\u003ccode\\u003eSamoa\\u003c/code\\u003e, \\u003ccode\\u003eTokelau Is.\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"locale\",\"full_name\":\"user[locale]\",\"description\":\"\\n\\u003cp\\u003eUser\\u0026#39;s + preferred locale\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003eca\\u003c/code\\u003e, \\u003ccode\\u003ecs_CZ\\u003c/code\\u003e, + \\u003ccode\\u003ede\\u003c/code\\u003e, \\u003ccode\\u003een\\u003c/code\\u003e, + \\u003ccode\\u003een_GB\\u003c/code\\u003e, \\u003ccode\\u003ees\\u003c/code\\u003e, + \\u003ccode\\u003efr\\u003c/code\\u003e, \\u003ccode\\u003eit\\u003c/code\\u003e, + \\u003ccode\\u003eja\\u003c/code\\u003e, \\u003ccode\\u003eka\\u003c/code\\u003e, + \\u003ccode\\u003eko\\u003c/code\\u003e, \\u003ccode\\u003epl\\u003c/code\\u003e, + \\u003ccode\\u003ept_BR\\u003c/code\\u003e, \\u003ccode\\u003eru\\u003c/code\\u003e, + \\u003ccode\\u003ezh_CN\\u003c/code\\u003e, \\u003ccode\\u003ezh_TW\\u003c/code\\u003e.\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"role_ids\",\"full_name\":\"user[role_ids]\",\"description\":\"\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"mail_enabled\",\"full_name\":\"user[mail_enabled]\",\"description\":\"\\n\\u003cp\\u003eEnable + user\\u0026#39;s email\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be one of: \\u003ccode\\u003etrue\\u003c/code\\u003e, \\u003ccode\\u003efalse\\u003c/code\\u003e, + \\u003ccode\\u003e1\\u003c/code\\u003e, \\u003ccode\\u003e0\\u003c/code\\u003e.\",\"expected_type\":\"boolean\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"location_ids\",\"full_name\":\"user[location_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + locations with given ids\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_ids\",\"full_name\":\"user[organization_ids]\",\"description\":\"\\n\\u003cp\\u003eREPLACE + organizations with given ids.\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"Must + be an array of any type\",\"expected_type\":\"array\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"current_password\",\"full_name\":\"user[current_password]\",\"description\":\"\\n\\u003cp\\u003eRequired + when user want to change own password\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":true,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}]}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/users/destroy\",\"name\":\"destroy\",\"apis\":[{\"api_url\":\"/api/users/:id\",\"http_method\":\"DELETE\",\"short_description\":\"Delete + a user\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"id\",\"full_name\":\"id\",\"description\":\"\",\"required\":true,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"String\",\"expected_type\":\"string\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true},{\"doc_url\":\"/apidoc/v2/users/extlogin\",\"name\":\"extlogin\",\"apis\":[{\"api_url\":\"/api/users/extlogin\",\"http_method\":\"GET\",\"short_description\":\"Use + to authenticate against external authentication source\",\"deprecated\":null}],\"formats\":null,\"full_description\":\"\",\"errors\":[],\"params\":[{\"name\":\"location_id\",\"full_name\":\"location_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current location context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false},{\"name\":\"organization_id\",\"full_name\":\"organization_id\",\"description\":\"\\n\\u003cp\\u003eSet + the current organization context for the request\\u003c/p\\u003e\\n\",\"required\":false,\"allow_nil\":false,\"allow_blank\":false,\"validator\":\"Integer\",\"expected_type\":\"numeric\",\"metadata\":null,\"show\":true,\"validations\":[],\"deprecated\":false}],\"returns\":[],\"examples\":[],\"metadata\":null,\"see\":[],\"headers\":[],\"show\":true}],\"headers\":null,\"deprecated\":null}}}}" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '1872925' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhook_templates?search=name%3D%22Katello+Publish%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 8,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Katello Publish\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"description\":\"Example + payload for actions.katello.content_view.publish_suceeded.event.foreman\",\"created_at\":\"2023-12-20 + 21:41:49 UTC\",\"updated_at\":\"2023-12-20 21:41:49 UTC\",\"name\":\"Katello + Publish\",\"id\":234}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '390' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks?search=name%3D%22Test+webhook%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 0,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test webhook\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": []\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '178' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: '{"webhook": {"name": "Test webhook", "target_url": "http://example.org:3128", + "event": "actions.katello.content_view.promote_succeeded.event.foreman", "webhook_template_id": + 234, "enabled": true}}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '196' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/api/webhooks + response: + body: + string: '{"target_url":"http://example.org:3128","event":"actions.katello.content_view.promote_succeeded.event.foreman","http_method":"POST","http_content_type":"application/json","enabled":true,"verify_ssl":true,"proxy_authorization":false,"http_headers":null,"ssl_ca_certs":null,"user":null,"created_at":"2024-01-08 + 15:20:17 UTC","updated_at":"2024-01-08 15:20:17 UTC","id":5,"name":"Test webhook","webhook_template":{"name":"Katello + Publish","id":234},"password_set":false}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '467' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 diff --git a/tests/test_playbooks/fixtures/webhook-1.yml b/tests/test_playbooks/fixtures/webhook-1.yml new file mode 100644 index 000000000..18004bf20 --- /dev/null +++ b/tests/test_playbooks/fixtures/webhook-1.yml @@ -0,0 +1,229 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"satellite_version":"6.15.0","result":"ok","status":200,"version":"3.9.0","api_version":2}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '91' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhook_templates?search=name%3D%22Katello+Publish%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 8,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Katello Publish\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"description\":\"Example + payload for actions.katello.content_view.publish_suceeded.event.foreman\",\"created_at\":\"2023-12-20 + 21:41:49 UTC\",\"updated_at\":\"2023-12-20 21:41:49 UTC\",\"name\":\"Katello + Publish\",\"id\":234}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '390' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks?search=name%3D%22Test+webhook%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test webhook\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"target_url\":\"http://example.org:3128\",\"enabled\":true,\"created_at\":\"2024-01-08 + 15:20:17 UTC\",\"updated_at\":\"2024-01-08 15:20:17 UTC\",\"id\":5,\"name\":\"Test + webhook\"}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '340' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks/5 + response: + body: + string: '{"target_url":"http://example.org:3128","event":"actions.katello.content_view.promote_succeeded.event.foreman","http_method":"POST","http_content_type":"application/json","enabled":true,"verify_ssl":true,"proxy_authorization":false,"http_headers":null,"ssl_ca_certs":null,"user":null,"created_at":"2024-01-08 + 15:20:17 UTC","updated_at":"2024-01-08 15:20:17 UTC","id":5,"name":"Test webhook","webhook_template":{"name":"Katello + Publish","id":234},"password_set":false}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '467' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/webhook-2.yml b/tests/test_playbooks/fixtures/webhook-2.yml new file mode 100644 index 000000000..c77b35b66 --- /dev/null +++ b/tests/test_playbooks/fixtures/webhook-2.yml @@ -0,0 +1,170 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"satellite_version":"6.15.0","result":"ok","status":200,"version":"3.9.0","api_version":2}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '91' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks?search=name%3D%22Test+webhook%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test webhook\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"target_url\":\"http://example.org:3128\",\"enabled\":true,\"created_at\":\"2024-01-08 + 15:20:17 UTC\",\"updated_at\":\"2024-01-08 15:20:17 UTC\",\"id\":5,\"name\":\"Test + webhook\"}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '340' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '0' + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: DELETE + uri: https://foreman.example.org/api/webhooks/5 + response: + body: + string: '{"id":5,"name":"Test webhook","target_url":"http://example.org:3128","events":["actions.katello.content_view.promote_succeeded.event.foreman"],"created_at":"2024-01-08T15:20:17.129Z","updated_at":"2024-01-08T15:20:17.129Z","webhook_template_id":234,"http_method":"POST","http_content_type":"application/json","enabled":true,"verify_ssl":true,"ssl_ca_certs":null,"user":null,"password":null,"http_headers":null,"proxy_authorization":false}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '438' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/webhook-3.yml b/tests/test_playbooks/fixtures/webhook-3.yml new file mode 100644 index 000000000..05f7ade67 --- /dev/null +++ b/tests/test_playbooks/fixtures/webhook-3.yml @@ -0,0 +1,112 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"satellite_version":"6.15.0","result":"ok","status":200,"version":"3.9.0","api_version":2}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '91' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks?search=name%3D%22Test+webhook%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 0,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test webhook\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": []\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '178' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/webhook-4.yml b/tests/test_playbooks/fixtures/webhook-4.yml new file mode 100644 index 000000000..ad5de421f --- /dev/null +++ b/tests/test_playbooks/fixtures/webhook-4.yml @@ -0,0 +1,233 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"satellite_version":"6.15.0","result":"ok","status":200,"version":"3.9.0","api_version":2}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '91' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhook_templates?search=name%3D%22Katello+Publish%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 8,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Katello Publish\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"description\":\"Example + payload for actions.katello.content_view.publish_suceeded.event.foreman\",\"created_at\":\"2023-12-20 + 21:41:49 UTC\",\"updated_at\":\"2023-12-20 21:41:49 UTC\",\"name\":\"Katello + Publish\",\"id\":234}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '390' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks?search=name%3D%22Test+webhook%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 0,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test webhook\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": []\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '178' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: '{"webhook": {"name": "Test webhook", "target_url": "http://example.org:3128", + "http_method": "POST", "event": "actions.katello.content_view.promote_succeeded.event.foreman", + "webhook_template_id": 234, "enabled": false, "user": "admin", "password": "secret_password"}}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '268' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/api/webhooks + response: + body: + string: '{"target_url":"http://example.org:3128","event":"actions.katello.content_view.promote_succeeded.event.foreman","http_method":"POST","http_content_type":"application/json","enabled":false,"verify_ssl":true,"proxy_authorization":false,"http_headers":null,"ssl_ca_certs":null,"user":"admin","created_at":"2024-01-08 + 15:20:21 UTC","updated_at":"2024-01-08 15:20:21 UTC","id":6,"name":"Test webhook","webhook_template":{"name":"Katello + Publish","id":234},"password_set":true}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '470' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 diff --git a/tests/test_playbooks/fixtures/webhook-5.yml b/tests/test_playbooks/fixtures/webhook-5.yml new file mode 100644 index 000000000..af2bb7ae3 --- /dev/null +++ b/tests/test_playbooks/fixtures/webhook-5.yml @@ -0,0 +1,229 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"satellite_version":"6.15.0","result":"ok","status":200,"version":"3.9.0","api_version":2}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '91' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhook_templates?search=name%3D%22Katello+Publish%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 8,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Katello Publish\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"description\":\"Example + payload for actions.katello.content_view.publish_suceeded.event.foreman\",\"created_at\":\"2023-12-20 + 21:41:49 UTC\",\"updated_at\":\"2023-12-20 21:41:49 UTC\",\"name\":\"Katello + Publish\",\"id\":234}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '390' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks?search=name%3D%22Test+webhook%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test webhook\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"target_url\":\"http://example.org:3128\",\"enabled\":false,\"created_at\":\"2024-01-08 + 15:20:21 UTC\",\"updated_at\":\"2024-01-08 15:20:21 UTC\",\"id\":6,\"name\":\"Test + webhook\"}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '341' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks/6 + response: + body: + string: '{"target_url":"http://example.org:3128","event":"actions.katello.content_view.promote_succeeded.event.foreman","http_method":"POST","http_content_type":"application/json","enabled":false,"verify_ssl":true,"proxy_authorization":false,"http_headers":null,"ssl_ca_certs":null,"user":"admin","created_at":"2024-01-08 + 15:20:21 UTC","updated_at":"2024-01-08 15:20:21 UTC","id":6,"name":"Test webhook","webhook_template":{"name":"Katello + Publish","id":234},"password_set":true}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '470' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/webhook-6.yml b/tests/test_playbooks/fixtures/webhook-6.yml new file mode 100644 index 000000000..215cc4910 --- /dev/null +++ b/tests/test_playbooks/fixtures/webhook-6.yml @@ -0,0 +1,230 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"satellite_version":"6.15.0","result":"ok","status":200,"version":"3.9.0","api_version":2}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '91' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks?search=name%3D%22Test+webhook%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test webhook\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"target_url\":\"http://example.org:3128\",\"enabled\":false,\"created_at\":\"2024-01-08 + 15:20:21 UTC\",\"updated_at\":\"2024-01-08 15:20:21 UTC\",\"id\":6,\"name\":\"Test + webhook\"}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '341' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks/6 + response: + body: + string: '{"target_url":"http://example.org:3128","event":"actions.katello.content_view.promote_succeeded.event.foreman","http_method":"POST","http_content_type":"application/json","enabled":false,"verify_ssl":true,"proxy_authorization":false,"http_headers":null,"ssl_ca_certs":null,"user":"admin","created_at":"2024-01-08 + 15:20:21 UTC","updated_at":"2024-01-08 15:20:21 UTC","id":6,"name":"Test webhook","webhook_template":{"name":"Katello + Publish","id":234},"password_set":true}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '470' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: '{"webhook": {"http_method": "PUT", "enabled": true}}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '52' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: PUT + uri: https://foreman.example.org/api/webhooks/6 + response: + body: + string: '{"target_url":"http://example.org:3128","event":"actions.katello.content_view.promote_succeeded.event.foreman","http_method":"PUT","http_content_type":"application/json","enabled":true,"verify_ssl":true,"proxy_authorization":false,"http_headers":null,"ssl_ca_certs":null,"user":"admin","created_at":"2024-01-08 + 15:20:21 UTC","updated_at":"2024-01-08 15:20:24 UTC","id":6,"name":"Test webhook","webhook_template":{"name":"Katello + Publish","id":234},"password_set":true}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '468' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/webhook-7.yml b/tests/test_playbooks/fixtures/webhook-7.yml new file mode 100644 index 000000000..2ee7c87cc --- /dev/null +++ b/tests/test_playbooks/fixtures/webhook-7.yml @@ -0,0 +1,170 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"satellite_version":"6.15.0","result":"ok","status":200,"version":"3.9.0","api_version":2}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '91' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks?search=name%3D%22Test+webhook%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test webhook\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"target_url\":\"http://example.org:3128\",\"enabled\":true,\"created_at\":\"2024-01-08 + 15:20:21 UTC\",\"updated_at\":\"2024-01-08 15:20:24 UTC\",\"id\":6,\"name\":\"Test + webhook\"}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '340' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks/6 + response: + body: + string: '{"target_url":"http://example.org:3128","event":"actions.katello.content_view.promote_succeeded.event.foreman","http_method":"PUT","http_content_type":"application/json","enabled":true,"verify_ssl":true,"proxy_authorization":false,"http_headers":null,"ssl_ca_certs":null,"user":"admin","created_at":"2024-01-08 + 15:20:21 UTC","updated_at":"2024-01-08 15:20:24 UTC","id":6,"name":"Test webhook","webhook_template":{"name":"Katello + Publish","id":234},"password_set":true}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '468' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/webhook-8.yml b/tests/test_playbooks/fixtures/webhook-8.yml new file mode 100644 index 000000000..5f73c300c --- /dev/null +++ b/tests/test_playbooks/fixtures/webhook-8.yml @@ -0,0 +1,170 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"satellite_version":"6.15.0","result":"ok","status":200,"version":"3.9.0","api_version":2}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '91' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks?search=name%3D%22Test+webhook%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test webhook\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"target_url\":\"http://example.org:3128\",\"enabled\":true,\"created_at\":\"2024-01-08 + 15:20:21 UTC\",\"updated_at\":\"2024-01-08 15:20:24 UTC\",\"id\":6,\"name\":\"Test + webhook\"}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '340' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '0' + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: DELETE + uri: https://foreman.example.org/api/webhooks/6 + response: + body: + string: '{"id":6,"name":"Test webhook","target_url":"http://example.org:3128","events":["actions.katello.content_view.promote_succeeded.event.foreman"],"created_at":"2024-01-08T15:20:21.684Z","updated_at":"2024-01-08T15:20:24.023Z","webhook_template_id":234,"http_method":"PUT","http_content_type":"application/json","enabled":true,"verify_ssl":true,"ssl_ca_certs":null,"user":"admin","password":"secret_password","http_headers":null,"proxy_authorization":false}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '453' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/webhook-9.yml b/tests/test_playbooks/fixtures/webhook-9.yml new file mode 100644 index 000000000..05f7ade67 --- /dev/null +++ b/tests/test_playbooks/fixtures/webhook-9.yml @@ -0,0 +1,112 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"satellite_version":"6.15.0","result":"ok","status":200,"version":"3.9.0","api_version":2}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '91' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/webhooks?search=name%3D%22Test+webhook%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 0,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test webhook\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": []\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '178' + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.9.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/tasks/webhook.yml b/tests/test_playbooks/tasks/webhook.yml new file mode 100644 index 000000000..70dc08ed5 --- /dev/null +++ b/tests/test_playbooks/tasks/webhook.yml @@ -0,0 +1,32 @@ +--- +- name: "Create/Update/Delete Webhook" + vars: + webhook_state: "present" + webhook: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + name: "{{ webhook_name }}" + target_url: "{{ webhook_target_url | default(omit)}}" + http_method: "{{ webhook_http_method | default(omit) }}" + http_content_type: "{{ webhook_http_content_type | default(omit) }}" + event: "{{ webhook_event | default(omit) }}" + webhook_template: "{{ webhook_template | default(omit) }}" + enabled: "{{ webhook_enabled | default(true) }}" + verify_ssl: "{{ webhook_verify_ssl | default(omit) }}" + ssl_ca_certs: "{{ webhook_ssl_ca_certs | default(omit) }}" + webhook_username: "{{ webhook_username | default(omit) }}" + webhook_password: "{{ webhook_password | default(omit) }}" + http_headers: "{{ webhook_http_headers | default(omit) }}" + proxy_authorization: "{{ webhook_proxy_authorization | default(omit) }}" + locations: "{{ webhook_locations | default(omit) }}" + organizations: "{{ webhook_organizations | default(omit) }}" + state: "{{ webhook_state }}" + register: result +- assert: + fail_msg: "Ensuring webhook is {{ webhook_state }} failed! (expected_change: {{ expected_change | default('unknown') }})" + that: + - result.changed == expected_change + when: expected_change is defined +... diff --git a/tests/test_playbooks/webhook.yml b/tests/test_playbooks/webhook.yml new file mode 100644 index 000000000..2552b97ed --- /dev/null +++ b/tests/test_playbooks/webhook.yml @@ -0,0 +1,91 @@ +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: create webhook + include_tasks: tasks/webhook.yml + vars: + webhook_state: "present" + webhook_name: "Test webhook" + webhook_target_url: "http://example.org:3128" + webhook_event: "actions.katello.content_view.promote_succeeded.event.foreman" + webhook_template: "Katello Publish" + expected_change: true + - name: create webhook again, no change + include_tasks: tasks/webhook.yml + vars: + webhook_state: "present" + webhook_name: "Test webhook" + webhook_target_url: "http://example.org:3128" + webhook_event: "actions.katello.content_view.promote_succeeded.event.foreman" + webhook_template: "Katello Publish" + expected_change: false + - name: delete webhook + include_tasks: tasks/webhook.yml + vars: + webhook_state: "absent" + webhook_name: "Test webhook" + expected_change: true + - name: delete webhook again, no change + include_tasks: tasks/webhook.yml + vars: + webhook_state: "absent" + webhook_name: "Test webhook" + expected_change: false + + - name: create webhook with user/pass + include_tasks: tasks/webhook.yml + vars: + webhook_state: "present" + webhook_name: "Test webhook" + webhook_target_url: "http://example.org:3128" + webhook_event: "actions.katello.content_view.promote_succeeded.event.foreman" + webhook_http_method: "POST" + webhook_username: "admin" + webhook_enabled: false + webhook_password: "secret_password" + webhook_template: "Katello Publish" + expected_change: true + - name: create webhook with user again, no change + include_tasks: tasks/webhook.yml + vars: + webhook_state: "present" + webhook_name: "Test webhook" + webhook_target_url: "http://example.org:3128" + webhook_event: "actions.katello.content_view.promote_succeeded.event.foreman" + webhook_http_method: "POST" + webhook_username: "admin" + webhook_template: "Katello Publish" + webhook_enabled: false + # don't set webhook_password here + expected_change: false + - name: update webhook with http_method + include_tasks: tasks/webhook.yml + vars: + webhook_state: "present" + webhook_name: "Test webhook" + webhook_http_method: "PUT" + expected_change: true + - name: update webhook with org/loc, no change + include_tasks: tasks/webhook.yml + vars: + webhook_state: "present" + webhook_name: "Test webhook" + webhook_http_method: "PUT" + expected_change: false + - name: delete webhook + include_tasks: tasks/webhook.yml + vars: + webhook_state: "absent" + webhook_name: "Test webhook" + expected_change: true + - name: delete webhook again, no change + include_tasks: tasks/webhook.yml + vars: + webhook_state: "absent" + webhook_name: "Test webhook" + expected_change: false +... From 0d055af25c0dd43716e3f3b6468418d756a09bed Mon Sep 17 00:00:00 2001 From: Steffen Scheib Date: Tue, 9 Jan 2024 15:17:46 +0100 Subject: [PATCH 16/19] Marking the execution as no_log when root_pass is defined. Fixes #1699 --- roles/hostgroups/tasks/main.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/roles/hostgroups/tasks/main.yml b/roles/hostgroups/tasks/main.yml index 18627a4f5..a5772f3b5 100644 --- a/roles/hostgroups/tasks/main.yml +++ b/roles/hostgroups/tasks/main.yml @@ -38,5 +38,6 @@ content_view: "{{ item.content_view | default(omit) }}" activation_keys: "{{ item.activation_keys | default(omit) }}" state: "{{ item.state | default(omit) }}" + no_log: "{{ item.root_pass is defined }}" with_items: - "{{ foreman_hostgroups }}" From b810ec0721c8a3d71bf47f0b77592bb010e29b9a Mon Sep 17 00:00:00 2001 From: Griffin Sullivan Date: Tue, 9 Jan 2024 12:22:30 -0500 Subject: [PATCH 17/19] Fix async and poll for cv publish role --- roles/content_view_publish/tasks/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/roles/content_view_publish/tasks/main.yml b/roles/content_view_publish/tasks/main.yml index 977c9dbc9..ca1fe0d3f 100644 --- a/roles/content_view_publish/tasks/main.yml +++ b/roles/content_view_publish/tasks/main.yml @@ -13,8 +13,8 @@ force_promote: "{{ content_view.force_promote | default(omit) }}" force_yum_metadata_regeneration: "{{ content_view.force_yum_metadata_regeneration | default(omit) }}" current_lifecycle_environment: "{{ content_view.current_lifecycle_environment | default(omit) }}" - async: "{{ foreman_content_view_publish_async | default(omit) }}" - poll: "{{ foreman_content_view_publish_poll | default(omit) }}" + async: "{{ foreman_content_view_publish_async | default(omit) }}" + poll: "{{ foreman_content_view_publish_poll | default(omit) }}" loop: "{{ foreman_content_views }}" loop_control: loop_var: "content_view" From a5f1070ba1eb7b0db571847436bc75d627b8c9f5 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Wed, 20 Dec 2023 11:49:09 +0100 Subject: [PATCH 18/19] exclude tests and changelog.yml from linting while our CI doesn't lint those anyway, ansible-lint as invoked by galaxy does and produces a ton of rather useless warnings. lets just ignore them :) --- .ansible-lint | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.ansible-lint b/.ansible-lint index 11ebceab2..c1efa0755 100644 --- a/.ansible-lint +++ b/.ansible-lint @@ -6,3 +6,6 @@ enable_list: - only-builtins only_builtins_allow_collections: - theforeman.foreman +exclude_paths: + - changelogs/changelog.yml + - tests/ From 81e9ebab5cf204261ebe42bd4afeaffbb4fbc3be Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Fri, 12 Jan 2024 09:05:38 +0100 Subject: [PATCH 19/19] Release 4.0.0 --- CHANGELOG.rst | 20 ++++++++++++++++++ changelogs/changelog.yaml | 21 +++++++++++++++++++ .../1247-reference_storage_pod_name.yml | 2 -- ...ntent_view_filter-drop-rule-management.yml | 2 -- .../inventory-no-default-localhost.yml | 2 -- galaxy.yml | 6 +++++- 6 files changed, 46 insertions(+), 7 deletions(-) delete mode 100644 changelogs/fragments/1247-reference_storage_pod_name.yml delete mode 100644 changelogs/fragments/content_view_filter-drop-rule-management.yml delete mode 100644 changelogs/fragments/inventory-no-default-localhost.yml diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 58d65c559..25b132caa 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -6,6 +6,26 @@ theforeman.foreman Release Notes This changelog describes changes after version 0.8.1. +v4.0.0 +====== + +Breaking Changes / Porting Guide +-------------------------------- + +- content_view_filter - stop managing rules from this module, ``content_view_filter_rule`` should be used for that +- inventory plugin - do not default to ``http://localhost:3000`` as the Foreman URL, providing a URL is now mandatory + +Bugfixes +-------- + +- compute_profile, host - refer to VMware storage pods by name, not id (https://github.com/theforeman/foreman-ansible-modules/issues/1247) + +New Modules +----------- + +- theforeman.foreman.registration_command - Manage Registration Command +- theforeman.foreman.webhook - Manage Webhooks + v3.15.0 ======= diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 7413664d2..ae5efcf3d 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -835,3 +835,24 @@ releases: name: hostgroup_info namespace: '' release_date: '2023-02-20' + 4.0.0: + changes: + breaking_changes: + - content_view_filter - stop managing rules from this module, ``content_view_filter_rule`` + should be used for that + - inventory plugin - do not default to ``http://localhost:3000`` as the Foreman + URL, providing a URL is now mandatory + bugfixes: + - compute_profile, host - refer to VMware storage pods by name, not id (https://github.com/theforeman/foreman-ansible-modules/issues/1247) + fragments: + - 1247-reference_storage_pod_name.yml + - content_view_filter-drop-rule-management.yml + - inventory-no-default-localhost.yml + modules: + - description: Manage Registration Command + name: registration_command + namespace: '' + - description: Manage Webhooks + name: webhook + namespace: '' + release_date: '2024-01-12' diff --git a/changelogs/fragments/1247-reference_storage_pod_name.yml b/changelogs/fragments/1247-reference_storage_pod_name.yml deleted file mode 100644 index 27e1fd6a5..000000000 --- a/changelogs/fragments/1247-reference_storage_pod_name.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - compute_profile, host - refer to VMware storage pods by name, not id (https://github.com/theforeman/foreman-ansible-modules/issues/1247) diff --git a/changelogs/fragments/content_view_filter-drop-rule-management.yml b/changelogs/fragments/content_view_filter-drop-rule-management.yml deleted file mode 100644 index 4df72636e..000000000 --- a/changelogs/fragments/content_view_filter-drop-rule-management.yml +++ /dev/null @@ -1,2 +0,0 @@ -breaking_changes: - - content_view_filter - stop managing rules from this module, ``content_view_filter_rule`` should be used for that diff --git a/changelogs/fragments/inventory-no-default-localhost.yml b/changelogs/fragments/inventory-no-default-localhost.yml deleted file mode 100644 index 528aff2f7..000000000 --- a/changelogs/fragments/inventory-no-default-localhost.yml +++ /dev/null @@ -1,2 +0,0 @@ -breaking_changes: - - inventory plugin - do not default to ``http://localhost:3000`` as the Foreman URL, providing a URL is now mandatory diff --git a/galaxy.yml b/galaxy.yml index 3e39af559..0041ec4ab 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -26,6 +26,7 @@ authors: - "Evgeni Golov " - "Ewoud Kohl van Wijngaarden " - "Felix Fontein " + - "Francesco Trentini " - "Gerald Vogt " - "Greg Swift " - "Griffin Sullivan " @@ -34,6 +35,7 @@ authors: - "Jameer Pathan " - "James Jeffers " - "James Stuart " + - "Jan Jansky " - "Jeffrey van Pelt " - "Jeremy Albinet " - "Jeremy Lenz " @@ -47,6 +49,7 @@ authors: - "Lester Cheung " - "Lester Claudio " - "Lucas Bickel " + - "Lukas Kallies " - "Lukas Magauer " - "Lukáš Zapletal " - "Manisha Singhal " @@ -78,6 +81,7 @@ authors: - "Sean O'Keeffe " - "Sorin Sbarnea " - "Steffen Frömer " + - "Steffen Scheib " - "Stoned Elipot " - "Sven Meeus " - "TTherouanne " @@ -99,7 +103,7 @@ authors: - "russianguppie <46544650+russianguppie@users.noreply.github.com>" - "willtome " - "yuqo2450 <79540477+yuqo2450@users.noreply.github.com>" -version: "3.15.0" +version: "4.0.0" license: - "GPL-3.0-or-later" tags: