From c74199c1a22e8e9a78b237a9f4f63e84bc88b66c Mon Sep 17 00:00:00 2001 From: Markus Bucher Date: Fri, 6 Jun 2025 21:01:44 +0200 Subject: [PATCH] Add environments for rolling content views requires https://github.com/Katello/katello/pull/11407 --- plugins/modules/content_view.py | 15 +- .../tasks/_create_content_view.yml | 2 + tests/fixtures/apidoc/katello.json | 2 +- tests/test_playbooks/content_view.yml | 28 ++ .../fixtures/content_view-0.yml | 255 +++++----- .../fixtures/content_view-1.yml | 261 ++++++----- .../fixtures/content_view-10.yml | 362 ++++++++------- .../fixtures/content_view-11.yml | 313 +++++++------ .../fixtures/content_view-12.yml | 207 +++++---- .../fixtures/content_view-13.yml | 245 +++++----- .../fixtures/content_view-14.yml | 165 ++++--- .../fixtures/content_view-15.yml | 165 ++++--- .../fixtures/content_view-16.yml | 261 +++++------ .../fixtures/content_view-17.yml | 115 +++-- .../fixtures/content_view-18.yml | 373 +++++++-------- .../fixtures/content_view-19.yml | 115 +++-- .../fixtures/content_view-2.yml | 265 +++++------ .../fixtures/content_view-20.yml | 212 ++++++++- .../fixtures/content_view-21.yml | 227 ++++++++- .../fixtures/content_view-22.yml | 360 ++++++++++++-- .../fixtures/content_view-23.yml | 4 +- .../fixtures/content_view-3.yml | 115 +++-- .../fixtures/content_view-4.yml | 255 +++++----- .../fixtures/content_view-5.yml | 364 +++++++-------- .../fixtures/content_view-6.yml | 377 +++++++-------- .../fixtures/content_view-7.yml | 376 +++++++-------- .../fixtures/content_view-8.yml | 439 +++++++++--------- .../fixtures/content_view-9.yml | 376 +++++++-------- .../fixtures/content_views_role-0.yml | 224 ++++----- .../fixtures/content_views_role-1.yml | 262 ++++++----- .../fixtures/content_views_role-2.yml | 224 ++++----- .../fixtures/content_views_role-3.yml | 178 +++---- .../fixtures/content_views_role-4.yml | 212 +++++---- tests/test_playbooks/tasks/content_view.yml | 1 + 34 files changed, 4071 insertions(+), 3284 deletions(-) mode change 100644 => 100755 plugins/modules/content_view.py diff --git a/plugins/modules/content_view.py b/plugins/modules/content_view.py old mode 100644 new mode 100755 index 488999187b..3d6483c0f0 --- a/plugins/modules/content_view.py +++ b/plugins/modules/content_view.py @@ -78,6 +78,14 @@ - A rolling content view contains latest synced state of repositories. type: bool version_added: 5.5.0 + lifecycle_environments: + description: + - List of lifecycle environments that content of this rolling content view will be promoted to. + - Ignored if I(rolling=False). + required: False + type: list + elements: str + version_added: 5.5.0 composite: description: - A composite view contains other content views. @@ -192,6 +200,7 @@ def main(): solve_dependencies=dict(type='bool'), import_only=dict(type='bool'), components=dict(type='nested_list', foreman_spec=cvc_foreman_spec, resolve=False), + lifecycle_environments=dict(type='entity_list', flat_name='environment_ids'), repositories=dict(type='entity_list', elements='dict', resolve=False, options=dict( name=dict(required=True), product=dict(required=True), @@ -200,7 +209,7 @@ def main(): argument_spec=dict( state=dict(default='present', choices=['present_with_defaults', 'present', 'absent']), ), - mutually_exclusive=[['repositories', 'components']], + mutually_exclusive=[['repositories', 'components'], ['lifecycle_environments', 'components']], entity_opts=dict(thin=False), ) @@ -226,6 +235,10 @@ def main(): repositories.append(module.find_resource_by_name('repositories', repository['name'], params={'product_id': product['id']}, thin=True)) module.foreman_params['repositories'] = repositories + if 'lifecycle_environments' in module.foreman_params: + if module.foreman_params['rolling'] is not True: + module.fail_json(msg="Lifecycle Environments can only be specified for Rolling Content View.") + if entity and module.desired_absent: for lce in entity.get('environments', []): module.resource_action('content_views', 'remove_from_environment', {'id': entity['id'], 'environment_id': lce['id']}) diff --git a/roles/content_views/tasks/_create_content_view.yml b/roles/content_views/tasks/_create_content_view.yml index 086c6f4a52..f19585a9cc 100644 --- a/roles/content_views/tasks/_create_content_view.yml +++ b/roles/content_views/tasks/_create_content_view.yml @@ -10,6 +10,8 @@ auto_publish: "{{ content_view.auto_publish | default(omit) }}" components: "{{ content_view.components | default(omit) }}" composite: "{{ content_view.components | default(content_view.composite) | default(false) | ternary(true, false) }}" + rolling: "{{ content_view.rolling | default(false) }}" + lifecycle_environments: "{{ content_view.lifecycle_environments | default(omit) }}" description: "{{ content_view.description | default(omit) }}" label: "{{ content_view.label | default(omit) }}" repositories: "{{ content_view.repositories | default(omit) }}" diff --git a/tests/fixtures/apidoc/katello.json b/tests/fixtures/apidoc/katello.json index 3e2a85dd5d..b1373dd6c1 100644 --- a/tests/fixtures/apidoc/katello.json +++ b/tests/fixtures/apidoc/katello.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":true}],"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":true}],"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":"Remove subscriptions from a host","deprecated":true}],"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":true}],"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":"limit_to_env","full_name":"content_overrides_search[limit_to_env]","description":"\n\u003cp\u003eLimit actions to content in the host\u0026#39;s 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":"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":"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":"bootc_available_digest","type":"string"},{"name":"bootc_available_image","type":"string"},{"name":"bootc_booted_digest","type":"string"},{"name":"bootc_booted_image","type":"string"},{"name":"bootc_rollback_digest","type":"string"},{"name":"bootc_rollback_image","type":"string"},{"name":"bootc_staged_digest","type":"string"},{"name":"bootc_staged_image","type":"string"},{"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":"convert2rhel_through_foreman","type":"integer"},{"name":"created_at","type":"datetime"},{"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":"image_mode","values":["true","false"]},{"name":"infrastructure_facet.foreman","values":["true","false"]},{"name":"infrastructure_facet.smart_proxy_id","type":""},{"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":"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":"service_level","type":"string"},{"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_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":"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":"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.","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":"\n\u003cp\u003eId of the single content view to be associated with the host.\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":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"\n\u003cp\u003eId of the single lifecycle environment to be associated with the host.\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":"content_view_environments","full_name":"host[content_facet_attributes][content_view_environments]","description":"\n\u003cp\u003eComma-separated list of content view environment labels to be associated with the host, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_view_environment_ids","full_name":"host[content_facet_attributes][content_view_environment_ids]","description":"\n\u003cp\u003eArray of content view environment ids to be associated with the host. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"\n\u003cp\u003eId of the smart proxy from which the host consumes content.\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":"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":"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}]}],"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":"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.","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":"\n\u003cp\u003eId of the single content view to be associated with the host.\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":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"\n\u003cp\u003eId of the single lifecycle environment to be associated with the host.\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":"content_view_environments","full_name":"host[content_facet_attributes][content_view_environments]","description":"\n\u003cp\u003eComma-separated list of content view environment labels to be associated with the host, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_view_environment_ids","full_name":"host[content_facet_attributes][content_view_environment_ids]","description":"\n\u003cp\u003eArray of content view environment ids to be associated with the host. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"\n\u003cp\u003eId of the smart proxy from which the host consumes content.\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":"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":"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}]}]}]}],"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":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003eexecution\u003c/code\u003e, \u003ccode\u003eerrata\u003c/code\u003e, \u003ccode\u003erhel_lifecycle\u003c/code\u003e, \u003ccode\u003etraces\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":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003eexecution\u003c/code\u003e, \u003ccode\u003eerrata\u003c/code\u003e, \u003ccode\u003erhel_lifecycle\u003c/code\u003e, \u003ccode\u003etraces\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, public\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}],"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":"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":"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. Takes precedence over the `organization` parameter\u003c/p\u003e\n","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","full_name":"organization","description":"\n\u003cp\u003eTitle of the Organization to register the host in\u003c/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 the Location to register the host in. Takes precedence over the `location` parameter\u003c/p\u003e\n","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","full_name":"location","description":"\n\u003cp\u003eTitle of the Location to register the host in\u003c/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 the Host group to register the host in. Takes precedence over the `hostgroup` parameter\u003c/p\u003e\n","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","full_name":"hostgroup","description":"\n\u003cp\u003eTitle of the Host group to register the host in\u003c/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 the Operating System to register the host in. Takes precedence over the `operatingsystem` parameter\u003c/p\u003e\n","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","full_name":"operatingsystem","description":"\n\u003cp\u003eTitle of the Operating System to register the host in\u003c/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_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\u003eDEPRECATED, use the `repo_data` 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":"repo_gpg_key_url","full_name":"repo_gpg_key_url","description":"\n\u003cp\u003eDEPRECATED, use the `repo_data` 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":"repo_data","full_name":"repo_data","description":"\n\u003cp\u003eArray with repository URL and corresponding GPG key URL\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":"repo","full_name":"repo_data[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_data[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":"download_utility","full_name":"download_utility","description":"\n\u003cp\u003eThe download utility to use during host registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecurl\u003c/code\u003e, \u003ccode\u003ewget\u003c/code\u003e.","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":"\n\u003cp\u003eId of the single content view to be associated with the host.\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":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"\n\u003cp\u003eId of the single lifecycle environment to be associated with the host.\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":"content_view_environments","full_name":"host[content_facet_attributes][content_view_environments]","description":"\n\u003cp\u003eComma-separated list of content view environment labels to be associated with the host, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_view_environment_ids","full_name":"host[content_facet_attributes][content_view_environment_ids]","description":"\n\u003cp\u003eArray of content view environment ids to be associated with the host. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"\n\u003cp\u003eId of the smart proxy from which the host consumes content.\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":"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":"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), 0 means \u0026#39;unlimited\u0026#39;.\u003c/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/wget\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\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\u003eDEPRECATED, use the `repo_data` param instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":true},{"name":"repo_gpg_key_url","full_name":"registration_command[repo_gpg_key_url]","description":"\n\u003cp\u003eDEPRECATED, use the `repo_data` param instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":true},{"name":"repo_data","full_name":"registration_command[repo_data]","description":"\n\u003cp\u003eArray with repository URL and corresponding GPG key URL\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":"repo","full_name":"registration_command[repo_data][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_data][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":"download_utility","full_name":"registration_command[download_utility]","description":"\n\u003cp\u003eThe download utility to use during host registration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecurl\u003c/code\u003e, \u003ccode\u003ewget\u003c/code\u003e.","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 or if you do not provide a host 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":[],"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/build","name":"build","apis":[{"api_url":"/api/hosts/bulk/build","http_method":"PUT","short_description":"Build","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_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}]},{"name":"reboot","full_name":"reboot","description":"\n\u003cp\u003eReboot after build. Ignored if rebuild_configuration is passed.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rebuild_configuration","full_name":"rebuild_configuration","description":"\n\u003cp\u003eRebuild configuration 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/hosts_bulk_actions/reassign_hostgroup","name":"reassign_hostgroup","apis":[{"api_url":"/api/hosts/bulk/reassign_hostgroups","http_method":"PUT","short_description":"Reassign 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\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}]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of the hostgroup to reassign the hosts 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/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":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\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":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\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":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\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}],"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":"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":"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}]}],"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":"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}]}],"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}],"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},"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},{"name":"http_proxy","full_name":"http_proxy","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"content_default_http_proxy","full_name":"http_proxy[content_default_http_proxy]","description":"\n\u003cp\u003eSet this HTTP proxy as the default content HTTP 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/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},{"name":"content_default_http_proxy","full_name":"http_proxy[content_default_http_proxy]","description":"\n\u003cp\u003eSet this HTTP proxy as the default content HTTP 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/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},"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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},"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, \u003ccode\u003enetiq\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, \u003ccode\u003enetiq\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},"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\u003c/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}]}],"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\u003c/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}]}],"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":true},{"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":true}],"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":true},{"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":true}],"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},"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":[],"deprecated":false},"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},"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},"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":[{"code":409,"description":"In case a nested entity exists","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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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\u003eSHA512\u003c/code\u003e, \u003ccode\u003eSHA256\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\u003eSHA512\u003c/code\u003e, \u003ccode\u003eSHA256\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":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":"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":"String","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":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/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}]}],"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":"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/:id/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":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID or title\u003c/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/:id/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":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID or title\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},"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},{"name":"hidden_value","full_name":"parameter[hidden_value]","description":"\n\u003cp\u003eShould the value be hidden\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\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/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},{"name":"hidden_value","full_name":"parameter[hidden_value]","description":"\n\u003cp\u003eShould the value be hidden\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\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/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},{"doc_url":"/apidoc/v2/permissions/current_permissions","name":"current_permissions","apis":[{"api_url":"/api/permissions/current_permissions","http_method":"GET","short_description":"List all permissions for current 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}],"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},"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":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\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/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":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\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/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":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\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/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":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\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},"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},"registration_tokens":{"doc_url":"/apidoc/v2/registration_tokens","id":"registration_tokens","api_url":"/api","name":"Registration_tokens","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/registration_tokens/invalidate_jwt","name":"invalidate_jwt","apis":[{"api_url":"/api/users/:user_id/registration_tokens","http_method":"DELETE","short_description":"Invalidate all registration tokens for a specific user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe user you specify will no longer be able to register hosts by using their JWTs.\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_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/registration_tokens/invalidate_jwt_tokens","name":"invalidate_jwt_tokens","apis":[{"api_url":"/api/registration_tokens","http_method":"DELETE","short_description":"Invalidate all registration tokens for multiple users","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe users you specify will no longer be able to register hosts by using their JWTs.\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\u003eSearch query that selects users for which registration tokens will be invalidated. Search query example: id ^ (2, 4, 6)\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},"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,"headers":[]}],"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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,"headers":[]}],"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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,"headers":[]}],"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"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\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\u003eDomain\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\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::AlternateContentSource\u003c/code\u003e, \u003ccode\u003eKatello::ContentCredential\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::FlatpakRemote\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\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\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\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\u003eDomain\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\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::AlternateContentSource\u003c/code\u003e, \u003ccode\u003eKatello::ContentCredential\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::FlatpakRemote\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\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":[],"deprecated":false},"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\u003eAlmaty\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\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\u003eAlmaty\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\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},"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":"content_view_environments","full_name":"content_view_environments","description":"\n\u003cp\u003eComma-separated list of content view environment labels associated with the activation key, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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_view_environment_ids","full_name":"content_view_environment_ids","description":"\n\u003cp\u003eArray of content view environment ids associated with the activation key. Ignored if content_view_id and lifecycle_environment_id are specified.Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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":"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","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"environment","type":"string"},{"name":"lifecycle_environment_id","type":"integer"},{"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":"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":"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":"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":"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":true},{"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":"environment","full_name":"environment","description":"\n\u003cp\u003eHash containing the Id of the single lifecycle environment to be associated with the activation key.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eId of the single content view to be associated with the activation key.\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":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the single lifecycle environment to be associated with the activation key.\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":"content_view_environments","full_name":"content_view_environments","description":"\n\u003cp\u003eComma-separated list of content view environment labels to be associated with the activation key, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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_view_environment_ids","full_name":"content_view_environment_ids","description":"\n\u003cp\u003eArray of content view environment ids to be associated with the activation key. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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":"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":"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":"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":true},{"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":"environment","full_name":"environment","description":"\n\u003cp\u003eHash containing the Id of the single lifecycle environment to be associated with the activation key.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eId of the single content view to be associated with the activation key.\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":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the single lifecycle environment to be associated with the activation key.\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":"content_view_environments","full_name":"content_view_environments","description":"\n\u003cp\u003eComma-separated list of content view environment labels to be associated with the activation key, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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_view_environment_ids","full_name":"content_view_environment_ids","description":"\n\u003cp\u003eArray of content view environment ids to be associated with the activation key. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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\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":"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}],"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":true}],"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":true}],"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":true},{"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/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/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},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the environment to limit the content counting 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 content counting 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 content counting 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/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},{"doc_url":"/apidoc/v2/capsule_content/verify_checksum","name":"verify_checksum","apis":[{"api_url":"/katello/api/capsules/:id/content/verify_checksum","http_method":"POST","short_description":"Check for missing or corrupted artifacts, and attempt to redownload them.","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},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the environment to limit verifying checksum 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 verifying checksum 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 verifying checksum 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}],"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, deb 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, deb 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, deb 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, deb 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, deb 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, deb 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;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\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_environments":{"doc_url":"/apidoc/v2/content_view_environments","id":"content_view_environments","api_url":"/api","name":"Content_view_environments","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_view_environments/index","name":"index","apis":[{"api_url":"/katello/api/content_view_environments","http_method":"GET","short_description":"List content view environments","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":"lifecycle_environment_id","full_name":"lifecycle_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":"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\u003eHost identifier\u003c/p\u003e\n","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}],"headers":[],"deprecated":false},"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},{"name":"allow_other_types","full_name":"allow_other_types","description":"\n\u003cp\u003eerratum: allow types not matching a valid errata 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":[],"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},{"name":"allow_other_types","full_name":"allow_other_types","description":"\n\u003cp\u003eerratum: allow types not matching a valid errata 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":[],"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},{"doc_url":"/apidoc/v2/content_view_versions/verify_checksum","name":"verify_checksum","apis":[{"api_url":"/katello/api/content_view_versions/:id/verify_checksum","http_method":"POST","short_description":"Verify checksum of repository contents in the 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}],"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","values":["true","false"]},{"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"},{"name":"rolling","values":["true","false"]}]},"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":"rolling","full_name":"rolling","description":"\n\u003cp\u003eRolling 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. Use to filter by 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":"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},{"name":"path_id","full_name":"path_id","description":"\n\u003cp\u003eIf you are adding an environment to an existing path after Library, pass the ID of the environment that is the current successor of Library in the path. It has to be the id of the old environment following library in this path.\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/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. Use to filter by 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":"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},"flatpak_remote_repositories":{"doc_url":"/apidoc/v2/flatpak_remote_repositories","id":"flatpak_remote_repositories","api_url":"/api","name":"Flatpak Remote Repositories","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/flatpak_remote_repositories/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/flatpak_remote_repositories","http_method":"GET","short_description":"List flatpak remote repositories","deprecated":null},{"api_url":"/katello/api/flatpak_remotes/:flatpak_remote_id/flatpak_remote_repositories","http_method":"GET","short_description":"List flatpak remote's repositories","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":"flatpak_remote_id","full_name":"flatpak_remote_id","description":"\n\u003cp\u003eID of flatpak remote to show repositories of\u003c/p\u003e\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 flatpak remote 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 flatpak remote\u003c/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":"flatpak_remote_id","type":"integer"},{"name":"label","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/flatpak_remote_repositories/show","name":"show","apis":[{"api_url":"/katello/api/flatpak_remote_repositories/:id","http_method":"GET","short_description":"Show a flatpak remote repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFlatpak remote repository 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":"manifests","full_name":"manifests","description":"\n\u003cp\u003eInclude manifests\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\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/flatpak_remote_repositories/mirror","name":"mirror","apis":[{"api_url":"/katello/api/flatpak_remote_repositories/:id/mirror","http_method":"POST","short_description":"Mirror a flatpak remote repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFlatpak remote repository 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":"product_id","full_name":"product_id","description":"\n\u003cp\u003eProduct ID to mirror the remote repository 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}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"flatpak_remotes":{"doc_url":"/apidoc/v2/flatpak_remotes","id":"flatpak_remotes","api_url":"/api","name":"Flatpak Remotes","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/flatpak_remotes/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/flatpak_remotes","http_method":"GET","short_description":"List flatpak remotes","deprecated":null},{"api_url":"/katello/api/flatpak_remotes","http_method":"GET","short_description":"List flatpak remotes","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":"name","full_name":"name","description":"\n\u003cp\u003eName of the flatpak remote\u003c/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":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"registry_url","type":"string"},{"name":"seeded","type":"boolean"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/flatpak_remotes/show","name":"show","apis":[{"api_url":"/katello/api/flatpak_remotes/:id","http_method":"GET","short_description":"Show a flatpak remote","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/flatpak_remotes/:id","http_method":"GET","short_description":"Show a flatpak remote","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFlatpak remote 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":"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/flatpak_remotes/create","name":"create","apis":[{"api_url":"/katello/api/flatpak_remotes","http_method":"POST","short_description":"Create a flatpak remote","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"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":"url","full_name":"url","description":"\n\u003cp\u003eBase URL of the flatpak registry index, ex: \u003ca href=\"https://flatpaks.redhat.io/rhel\"\u003eflatpaks.redhat.io/rhel\u003c/a\u003e/ , \u003ca href=\"https://registry.fedoraproject.org\"\u003eregistry.fedoraproject.org\u003c/a\u003e/.\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":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 of the flatpak remote\u003c/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 the flatpak remote\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token","full_name":"token","description":"\n\u003cp\u003eToken/password for the flatpak remote\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/flatpak_remotes/update","name":"update","apis":[{"api_url":"/katello/api/flatpak_remotes/:id","http_method":"PUT","short_description":"Update a flatpak remote","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the flatpak remote\u003c/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 the flatpak remote\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token","full_name":"token","description":"\n\u003cp\u003eToken/password for the flatpak remote\u003c/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\u003eFlatpak remote 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\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":"url","full_name":"url","description":"\n\u003cp\u003eBase URL of the flatpak registry index, ex: \u003ca href=\"https://flatpaks.redhat.io/rhel\"\u003eflatpaks.redhat.io/rhel\u003c/a\u003e/ , \u003ca href=\"https://registry.fedoraproject.org\"\u003eregistry.fedoraproject.org\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":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/flatpak_remotes/destroy","name":"destroy","apis":[{"api_url":"/katello/api/flatpak_remotes/:id","http_method":"DELETE","short_description":"Delete a flatpak remote","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFlatpak remote 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/flatpak_remotes/scan","name":"scan","apis":[{"api_url":"/katello/api/flatpak_remotes/:id/scan","http_method":"POST","short_description":"Scan a flatpak remote","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFlatpak remote 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},"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":"","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":"","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":"","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":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_bootc_images":{"doc_url":"/apidoc/v2/host_bootc_images","id":"host_bootc_images","api_url":"/api","name":"Host_bootc_images","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/host_bootc_images/bootc_images","name":"bootc_images","apis":[{"api_url":"/api/hosts/bootc_images","http_method":"GET","short_description":"List booted bootc container images for hosts","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}],"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":"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":"architecture","type":"string"},{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"version","type":"string"}]},"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},{"doc_url":"/apidoc/v2/host_packages/show","name":"show","apis":[{"api_url":"/api/host_packages/:id","http_method":"GET","short_description":"Show :a_resource","deprecated":null},{"api_url":"/api/repositories/:repository_id/host_packages/:id","http_method":"GET","short_description":"Show :a_resource","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\u003e:a_resource 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/host_packages/compare","name":"compare","apis":[{"api_url":"/api/host_packages/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/host_packages/installed_packages","name":"installed_packages","apis":[{"api_url":"/api/host_packages/installed_packages","http_method":"GET","short_description":"Return a list of installed packages distinct by name","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}],"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},"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},"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. Use to filter by 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":"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},{"doc_url":"/apidoc/v2/packages/thindex","name":"thindex","apis":[{"api_url":"/katello/api/packages/thindex","http_method":"GET","short_description":"List all packages unique by name","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}],"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, rhel-10\u003c/p\u003e\n","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 used for published repository contents. Supported types: sha256, sha384, sha512\u003c/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 deb, docker, file and yum 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\u003eUpstream authentication token string for yum repositories.\u003c/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":"depth","full_name":"depth","description":"\n\u003cp\u003eAn option to specify how many ostree commits to traverse.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude_refs","full_name":"exclude_refs","description":"\n\u003cp\u003eA comma-separated list of tags to exclude during an ostree sync. The wildcards *, ? are recognized. \u0026#39;exclude_refs\u0026#39; is evaluated after \u0026#39;include_refs\u0026#39;.\u003c/p\u003e\n","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_refs","full_name":"include_refs","description":"\n\u003cp\u003eA comma-separated list of refs to include during an ostree sync. The wildcards *, ? are recognized.\u003c/p\u003e\n","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":"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":"keep_latest_packages","full_name":"keep_latest_packages","description":"\n\u003cp\u003eThe amount of latest versions of a package to keep on sync, includes pre-releases if synced. Default 0 keeps all versions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","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":"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, rhel-10\u003c/p\u003e\n","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 used for published repository contents. Supported types: sha256, sha384, sha512\u003c/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 deb, docker, file and yum 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\u003eUpstream authentication token string for yum repositories.\u003c/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":"depth","full_name":"depth","description":"\n\u003cp\u003eAn option to specify how many ostree commits to traverse.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude_refs","full_name":"exclude_refs","description":"\n\u003cp\u003eA comma-separated list of tags to exclude during an ostree sync. The wildcards *, ? are recognized. \u0026#39;exclude_refs\u0026#39; is evaluated after \u0026#39;include_refs\u0026#39;.\u003c/p\u003e\n","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_refs","full_name":"include_refs","description":"\n\u003cp\u003eA comma-separated list of refs to include during an ostree sync. The wildcards *, ? are recognized.\u003c/p\u003e\n","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":"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":"keep_latest_packages","full_name":"keep_latest_packages","description":"\n\u003cp\u003eThe amount of latest versions of a package to keep on sync, includes pre-releases if synced. Default 0 keeps all versions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","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":"This endpoint is primarily designed for UI interactions and uploading content into the repository. For API-based uploads, please use the 'content_uploads' endpoint instead.","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\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":true},{"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},"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},"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}]}],"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/hosts","name":"hosts","apis":[{"api_url":"/api/job_invocations/:id/hosts","http_method":"GET","short_description":"List hosts 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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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":{"search":[{"name":"description","type":"string"},{"name":"ended_at","type":"datetime"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"job_category","type":"string"},{"name":"owner","type":"string"},{"name":"pattern_template_name","type":"string"},{"name":"recurring","values":["true","false"]},{"name":"recurring_logic.id","type":"integer"},{"name":"recurring_logic.purpose","type":"string"},{"name":"start_at","type":"datetime"},{"name":"started_at","type":"datetime"},{"name":"status","values":["succeeded","failed","queued","running","cancelled"]},{"name":"targeted_host_id","type":"string"},{"name":"user","type":"string"}]},"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},{"name":"succeeded_only","full_name":"succeeded_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},"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":"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}]},{"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.","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}]}],"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.","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}]}],"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},"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},"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}}}} \ 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":true}],"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":true}],"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":"Remove subscriptions from a host","deprecated":true}],"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":true}],"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":"limit_to_env","full_name":"content_overrides_search[limit_to_env]","description":"\n\u003cp\u003eLimit actions to content in the host\u0026#39;s 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":"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":"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":"bootc_available_digest","type":"string"},{"name":"bootc_available_image","type":"string"},{"name":"bootc_booted_digest","type":"string"},{"name":"bootc_booted_image","type":"string"},{"name":"bootc_rollback_digest","type":"string"},{"name":"bootc_rollback_image","type":"string"},{"name":"bootc_staged_digest","type":"string"},{"name":"bootc_staged_image","type":"string"},{"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":"convert2rhel_through_foreman","type":"integer"},{"name":"created_at","type":"datetime"},{"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":"image_mode","values":["true","false"]},{"name":"infrastructure_facet.foreman","values":["true","false"]},{"name":"infrastructure_facet.smart_proxy_id","type":""},{"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":"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":"service_level","type":"string"},{"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_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":"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":"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.","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":"\n\u003cp\u003eId of the single content view to be associated with the host.\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":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"\n\u003cp\u003eId of the single lifecycle environment to be associated with the host.\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":"content_view_environments","full_name":"host[content_facet_attributes][content_view_environments]","description":"\n\u003cp\u003eComma-separated list of content view environment labels to be associated with the host, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_view_environment_ids","full_name":"host[content_facet_attributes][content_view_environment_ids]","description":"\n\u003cp\u003eArray of content view environment ids to be associated with the host. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"\n\u003cp\u003eId of the smart proxy from which the host consumes content.\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":"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":"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}]}],"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":"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.","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":"\n\u003cp\u003eId of the single content view to be associated with the host.\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":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"\n\u003cp\u003eId of the single lifecycle environment to be associated with the host.\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":"content_view_environments","full_name":"host[content_facet_attributes][content_view_environments]","description":"\n\u003cp\u003eComma-separated list of content view environment labels to be associated with the host, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_view_environment_ids","full_name":"host[content_facet_attributes][content_view_environment_ids]","description":"\n\u003cp\u003eArray of content view environment ids to be associated with the host. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"\n\u003cp\u003eId of the smart proxy from which the host consumes content.\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":"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":"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}]}]}]}],"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":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003eexecution\u003c/code\u003e, \u003ccode\u003eerrata\u003c/code\u003e, \u003ccode\u003erhel_lifecycle\u003c/code\u003e, \u003ccode\u003etraces\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":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003eexecution\u003c/code\u003e, \u003ccode\u003eerrata\u003c/code\u003e, \u003ccode\u003erhel_lifecycle\u003c/code\u003e, \u003ccode\u003etraces\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, public\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}],"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":"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":"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. Takes precedence over the `organization` parameter\u003c/p\u003e\n","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","full_name":"organization","description":"\n\u003cp\u003eTitle of the Organization to register the host in\u003c/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 the Location to register the host in. Takes precedence over the `location` parameter\u003c/p\u003e\n","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","full_name":"location","description":"\n\u003cp\u003eTitle of the Location to register the host in\u003c/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 the Host group to register the host in. Takes precedence over the `hostgroup` parameter\u003c/p\u003e\n","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","full_name":"hostgroup","description":"\n\u003cp\u003eTitle of the Host group to register the host in\u003c/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 the Operating System to register the host in. Takes precedence over the `operatingsystem` parameter\u003c/p\u003e\n","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","full_name":"operatingsystem","description":"\n\u003cp\u003eTitle of the Operating System to register the host in\u003c/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_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\u003eDEPRECATED, use the `repo_data` 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":"repo_gpg_key_url","full_name":"repo_gpg_key_url","description":"\n\u003cp\u003eDEPRECATED, use the `repo_data` 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":"repo_data","full_name":"repo_data","description":"\n\u003cp\u003eArray with repository URL and corresponding GPG key URL\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":"repo","full_name":"repo_data[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_data[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":"download_utility","full_name":"download_utility","description":"\n\u003cp\u003eThe download utility to use during host registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecurl\u003c/code\u003e, \u003ccode\u003ewget\u003c/code\u003e.","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":"\n\u003cp\u003eId of the single content view to be associated with the host.\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":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"\n\u003cp\u003eId of the single lifecycle environment to be associated with the host.\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":"content_view_environments","full_name":"host[content_facet_attributes][content_view_environments]","description":"\n\u003cp\u003eComma-separated list of content view environment labels to be associated with the host, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_view_environment_ids","full_name":"host[content_facet_attributes][content_view_environment_ids]","description":"\n\u003cp\u003eArray of content view environment ids to be associated with the host. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be 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_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"\n\u003cp\u003eId of the smart proxy from which the host consumes content.\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":"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":"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), 0 means \u0026#39;unlimited\u0026#39;.\u003c/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/wget\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\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\u003eDEPRECATED, use the `repo_data` param instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":true},{"name":"repo_gpg_key_url","full_name":"registration_command[repo_gpg_key_url]","description":"\n\u003cp\u003eDEPRECATED, use the `repo_data` param instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":true},{"name":"repo_data","full_name":"registration_command[repo_data]","description":"\n\u003cp\u003eArray with repository URL and corresponding GPG key URL\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":"repo","full_name":"registration_command[repo_data][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_data][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":"download_utility","full_name":"registration_command[download_utility]","description":"\n\u003cp\u003eThe download utility to use during host registration\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecurl\u003c/code\u003e, \u003ccode\u003ewget\u003c/code\u003e.","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 or if you do not provide a host 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":[],"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},{"name":"setup_container_registry_certs","full_name":"registration_command[setup_container_registry_certs]","description":"\n\u003cp\u003eUse container certificates for container registry authentication. If it is set to true, container registry certificates 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}]}],"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/build","name":"build","apis":[{"api_url":"/api/hosts/bulk/build","http_method":"PUT","short_description":"Build","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_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}]},{"name":"reboot","full_name":"reboot","description":"\n\u003cp\u003eReboot after build. Ignored if rebuild_configuration is passed.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rebuild_configuration","full_name":"rebuild_configuration","description":"\n\u003cp\u003eRebuild configuration 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/hosts_bulk_actions/reassign_hostgroup","name":"reassign_hostgroup","apis":[{"api_url":"/api/hosts/bulk/reassign_hostgroups","http_method":"PUT","short_description":"Reassign 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\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}]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of the hostgroup to reassign the hosts 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/hosts_bulk_actions/change_owner","name":"change_owner","apis":[{"api_url":"/api/hosts/bulk/change_owner","http_method":"PUT","short_description":"Change owner","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_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}]},{"name":"owner_id","full_name":"owner_id","description":"\n\u003cp\u003eID of the owner to reassign the hosts 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}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/bulk/disassociate","http_method":"PUT","short_description":"Disassociate compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_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/assign_organization","name":"assign_organization","apis":[{"api_url":"/api/hosts/bulk/assign_organization","http_method":"PUT","short_description":"Assign 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\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}]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe organization ID to assign the hosts 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":"mismatch_setting","full_name":"mismatch_setting","description":"\n\u003cp\u003eFix organization on mismatch\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}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/hosts_bulk_actions/assign_location","name":"assign_location","apis":[{"api_url":"/api/hosts/bulk/assign_location","http_method":"PUT","short_description":"Assign 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\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}]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe location ID to assign the hosts 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":"mismatch_setting","full_name":"mismatch_setting","description":"\n\u003cp\u003eFix location on mismatch\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}],"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":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\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":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\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":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\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}],"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":"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":"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}]}],"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":"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}]}],"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}],"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},"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},{"name":"http_proxy","full_name":"http_proxy","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"content_default_http_proxy","full_name":"http_proxy[content_default_http_proxy]","description":"\n\u003cp\u003eSet this HTTP proxy as the default content HTTP 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/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},{"name":"content_default_http_proxy","full_name":"http_proxy[content_default_http_proxy]","description":"\n\u003cp\u003eSet this HTTP proxy as the default content HTTP 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/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},"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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},"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. Deprecated in favor of ldap_group_membership = nis_netgroups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \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":"ldap_group_membership","full_name":"auth_source_ldap[ldap_group_membership]","description":"\n\u003cp\u003etype of group membership to use, applicable only when server_type is posix, free_ipa or netiq. Option rfc4519 is only applicable when server_type is posix.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eposix\u003c/code\u003e, \u003ccode\u003erfc4519\u003c/code\u003e, \u003ccode\u003enis_netgroups\u003c/code\u003e.","expected_type":"string","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, \u003ccode\u003enetiq\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. Deprecated in favor of ldap_group_membership = nis_netgroups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \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":"ldap_group_membership","full_name":"auth_source_ldap[ldap_group_membership]","description":"\n\u003cp\u003etype of group membership to use, applicable only when server_type is posix, free_ipa or netiq. Option rfc4519 is only applicable when server_type is posix.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eposix\u003c/code\u003e, \u003ccode\u003erfc4519\u003c/code\u003e, \u003ccode\u003enis_netgroups\u003c/code\u003e.","expected_type":"string","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, \u003ccode\u003enetiq\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},"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\u003c/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 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 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 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 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":"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 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":"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}]}],"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\u003c/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 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 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 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 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":"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 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":"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}]}],"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_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":true},{"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":true}],"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":true},{"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":true}],"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},"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":[],"deprecated":false},"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},"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},"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":[{"code":409,"description":"In case a nested entity exists","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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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\u003eSHA512\u003c/code\u003e, \u003ccode\u003eSHA256\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\u003eSHA512\u003c/code\u003e, \u003ccode\u003eSHA256\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":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":"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":"String","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":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/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}]}],"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":"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/:id/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":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID or title\u003c/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/:id/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":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID or title\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},"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},{"name":"hidden_value","full_name":"parameter[hidden_value]","description":"\n\u003cp\u003eShould the value be hidden\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\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/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},{"name":"hidden_value","full_name":"parameter[hidden_value]","description":"\n\u003cp\u003eShould the value be hidden\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\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/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},{"doc_url":"/apidoc/v2/permissions/current_permissions","name":"current_permissions","apis":[{"api_url":"/api/permissions/current_permissions","http_method":"GET","short_description":"List all permissions for current 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}],"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},"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":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\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/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":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\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/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":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\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/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":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\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},"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},"registration_tokens":{"doc_url":"/apidoc/v2/registration_tokens","id":"registration_tokens","api_url":"/api","name":"Registration_tokens","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/registration_tokens/invalidate_jwt","name":"invalidate_jwt","apis":[{"api_url":"/api/users/:user_id/registration_tokens","http_method":"DELETE","short_description":"Invalidate all registration tokens for a specific user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe user you specify will no longer be able to register hosts by using their JWTs.\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_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/registration_tokens/invalidate_jwt_tokens","name":"invalidate_jwt_tokens","apis":[{"api_url":"/api/registration_tokens","http_method":"DELETE","short_description":"Invalidate all registration tokens for multiple users","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe users you specify will no longer be able to register hosts by using their JWTs.\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\u003eSearch query that selects users for which registration tokens will be invalidated. Search query example: id ^ (2, 4, 6)\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},"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,"headers":[]}],"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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,"headers":[]}],"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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,"headers":[]}],"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"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\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\u003eDomain\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\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::AlternateContentSource\u003c/code\u003e, \u003ccode\u003eKatello::ContentCredential\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::FlatpakRemote\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\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\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\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\u003eDomain\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\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::AlternateContentSource\u003c/code\u003e, \u003ccode\u003eKatello::ContentCredential\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::FlatpakRemote\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\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"validations":[],"deprecated":false},{"name":"organization_id","full_name":"organization_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":false,"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":[],"deprecated":false},"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\u003eAlmaty\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\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\u003eAlmaty\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\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},"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":"content_view_environments","full_name":"content_view_environments","description":"\n\u003cp\u003eComma-separated list of content view environment labels associated with the activation key, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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_view_environment_ids","full_name":"content_view_environment_ids","description":"\n\u003cp\u003eArray of content view environment ids associated with the activation key. Ignored if content_view_id and lifecycle_environment_id are specified.Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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":"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","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"environment","type":"string"},{"name":"lifecycle_environment_id","type":"integer"},{"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":"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":"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":"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":"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":true},{"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":"environment","full_name":"environment","description":"\n\u003cp\u003eHash containing the Id of the single lifecycle environment to be associated with the activation key.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eId of the single content view to be associated with the activation key.\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":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the single lifecycle environment to be associated with the activation key.\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":"content_view_environments","full_name":"content_view_environments","description":"\n\u003cp\u003eComma-separated list of content view environment labels to be associated with the activation key, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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_view_environment_ids","full_name":"content_view_environment_ids","description":"\n\u003cp\u003eArray of content view environment ids to be associated with the activation key. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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":"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":"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":"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":true},{"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":"environment","full_name":"environment","description":"\n\u003cp\u003eHash containing the Id of the single lifecycle environment to be associated with the activation key.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eId of the single content view to be associated with the activation key.\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":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the single lifecycle environment to be associated with the activation key.\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":"content_view_environments","full_name":"content_view_environments","description":"\n\u003cp\u003eComma-separated list of content view environment labels to be associated with the activation key, in the format of \u0026#39;lifecycle_environment_label/content_view_label\u0026#39;. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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_view_environment_ids","full_name":"content_view_environment_ids","description":"\n\u003cp\u003eArray of content view environment ids to be associated with the activation key. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.\u003c/p\u003e\n","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\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":"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}],"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":true}],"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":true}],"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":true},{"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/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/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},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the environment to limit the content counting 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 content counting 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 content counting 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/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},{"doc_url":"/apidoc/v2/capsule_content/verify_checksum","name":"verify_checksum","apis":[{"api_url":"/katello/api/capsules/:id/content/verify_checksum","http_method":"POST","short_description":"Check for missing or corrupted artifacts, and attempt to redownload them.","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},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the environment to limit verifying checksum 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 verifying checksum 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 verifying checksum 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}],"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, deb 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, deb 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, deb 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, deb 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, deb 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, deb 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;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\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_environments":{"doc_url":"/apidoc/v2/content_view_environments","id":"content_view_environments","api_url":"/api","name":"Content_view_environments","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/content_view_environments/index","name":"index","apis":[{"api_url":"/katello/api/content_view_environments","http_method":"GET","short_description":"List content view environments","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":"lifecycle_environment_id","full_name":"lifecycle_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":"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\u003eHost identifier\u003c/p\u003e\n","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}],"headers":[],"deprecated":false},"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},{"name":"allow_other_types","full_name":"allow_other_types","description":"\n\u003cp\u003eerratum: allow types not matching a valid errata 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":[],"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},{"name":"allow_other_types","full_name":"allow_other_types","description":"\n\u003cp\u003eerratum: allow types not matching a valid errata 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":[],"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},{"doc_url":"/apidoc/v2/content_view_versions/verify_checksum","name":"verify_checksum","apis":[{"api_url":"/katello/api/content_view_versions/:id/verify_checksum","http_method":"POST","short_description":"Verify checksum of repository contents in the 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}],"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","values":["true","false"]},{"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"},{"name":"rolling","values":["true","false"]}]},"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":"rolling","full_name":"rolling","description":"\n\u003cp\u003eRolling 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":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eList of lifecycle environments for rolling 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":"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":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eList of lifecycle environments for rolling 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":"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. Use to filter by 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":"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},{"name":"path_id","full_name":"path_id","description":"\n\u003cp\u003eIf you are adding an environment to an existing path after Library, pass the ID of the environment that is the current successor of Library in the path. It has to be the id of the old environment following library in this path.\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/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. Use to filter by 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":"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","values":["security","bugfix","enhancement","other"]},{"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},"flatpak_remote_repositories":{"doc_url":"/apidoc/v2/flatpak_remote_repositories","id":"flatpak_remote_repositories","api_url":"/api","name":"Flatpak Remote Repositories","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/flatpak_remote_repositories/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/flatpak_remote_repositories","http_method":"GET","short_description":"List flatpak remote repositories","deprecated":null},{"api_url":"/katello/api/flatpak_remotes/:flatpak_remote_id/flatpak_remote_repositories","http_method":"GET","short_description":"List flatpak remote's repositories","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":"flatpak_remote_id","full_name":"flatpak_remote_id","description":"\n\u003cp\u003eID of flatpak remote to show repositories of\u003c/p\u003e\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 flatpak remote 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 flatpak remote\u003c/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":"flatpak_remote_id","type":"integer"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/flatpak_remote_repositories/show","name":"show","apis":[{"api_url":"/katello/api/flatpak_remote_repositories/:id","http_method":"GET","short_description":"Show a flatpak remote repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFlatpak remote repository 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":"manifests","full_name":"manifests","description":"\n\u003cp\u003eInclude manifests\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\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/flatpak_remote_repositories/mirror","name":"mirror","apis":[{"api_url":"/katello/api/flatpak_remote_repositories/:id/mirror","http_method":"POST","short_description":"Mirror a flatpak remote repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFlatpak remote repository 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":"product_id","full_name":"product_id","description":"\n\u003cp\u003eProduct ID to mirror the remote repository 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":"product_name","full_name":"product_name","description":"\n\u003cp\u003eName of the product to mirror the remote repository 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":"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},"flatpak_remotes":{"doc_url":"/apidoc/v2/flatpak_remotes","id":"flatpak_remotes","api_url":"/api","name":"Flatpak Remotes","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/flatpak_remotes/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/flatpak_remotes","http_method":"GET","short_description":"List flatpak remotes","deprecated":null},{"api_url":"/katello/api/flatpak_remotes","http_method":"GET","short_description":"List flatpak remotes","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 flatpak remote\u003c/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":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"registry_url","type":"string"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/flatpak_remotes/show","name":"show","apis":[{"api_url":"/katello/api/flatpak_remotes/:id","http_method":"GET","short_description":"Show a flatpak remote","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/flatpak_remotes/:id","http_method":"GET","short_description":"Show a flatpak remote","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFlatpak remote 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":"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/flatpak_remotes/create","name":"create","apis":[{"api_url":"/katello/api/flatpak_remotes","http_method":"POST","short_description":"Create a flatpak remote","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"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":"url","full_name":"url","description":"\n\u003cp\u003eBase URL of the flatpak registry index, ex: \u003ca href=\"https://flatpaks.redhat.io/rhel\"\u003eflatpaks.redhat.io/rhel\u003c/a\u003e/ , \u003ca href=\"https://registry.fedoraproject.org\"\u003eregistry.fedoraproject.org\u003c/a\u003e/.\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":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 of the flatpak remote\u003c/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 the flatpak remote\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token","full_name":"token","description":"\n\u003cp\u003eToken/password for the flatpak remote\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/flatpak_remotes/update","name":"update","apis":[{"api_url":"/katello/api/flatpak_remotes/:id","http_method":"PUT","short_description":"Update a flatpak remote","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the flatpak remote\u003c/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 the flatpak remote\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token","full_name":"token","description":"\n\u003cp\u003eToken/password for the flatpak remote\u003c/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\u003eFlatpak remote 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\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":"url","full_name":"url","description":"\n\u003cp\u003eBase URL of the flatpak registry index, ex: \u003ca href=\"https://flatpaks.redhat.io/rhel\"\u003eflatpaks.redhat.io/rhel\u003c/a\u003e/ , \u003ca href=\"https://registry.fedoraproject.org\"\u003eregistry.fedoraproject.org\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":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/flatpak_remotes/destroy","name":"destroy","apis":[{"api_url":"/katello/api/flatpak_remotes/:id","http_method":"DELETE","short_description":"Delete a flatpak remote","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFlatpak remote 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/flatpak_remotes/scan","name":"scan","apis":[{"api_url":"/katello/api/flatpak_remotes/:id/scan","http_method":"POST","short_description":"Scan a flatpak remote","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFlatpak remote 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},"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":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epython_package\u003c/code\u003e.","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":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epython_package\u003c/code\u003e.","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":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epython_package\u003c/code\u003e.","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":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epython_package\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_bootc_images":{"doc_url":"/apidoc/v2/host_bootc_images","id":"host_bootc_images","api_url":"/api","name":"Host_bootc_images","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/v2/host_bootc_images/bootc_images","name":"bootc_images","apis":[{"api_url":"/api/hosts/bootc_images","http_method":"GET","short_description":"List booted bootc container images for hosts","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}],"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":"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":"architecture","type":"string"},{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/host_debs/show","name":"show","apis":[{"api_url":"/api/host_debs/:id","http_method":"GET","short_description":"Show :a_resource","deprecated":null},{"api_url":"/api/repositories/:repository_id/host_debs/:id","http_method":"GET","short_description":"Show :a_resource","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\u003e:a_resource 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/host_debs/compare","name":"compare","apis":[{"api_url":"/api/host_debs/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/host_debs/installed_debs","name":"installed_debs","apis":[{"api_url":"/api/host_debs/installed_debs","http_method":"GET","short_description":"Return a list of installed debs distinct by name","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}],"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, other)\u003c/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},{"doc_url":"/apidoc/v2/host_packages/show","name":"show","apis":[{"api_url":"/api/host_packages/:id","http_method":"GET","short_description":"Show :a_resource","deprecated":null},{"api_url":"/api/repositories/:repository_id/host_packages/:id","http_method":"GET","short_description":"Show :a_resource","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\u003e:a_resource 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/host_packages/compare","name":"compare","apis":[{"api_url":"/api/host_packages/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/host_packages/installed_packages","name":"installed_packages","apis":[{"api_url":"/api/host_packages/installed_packages","http_method":"GET","short_description":"Return a list of installed packages distinct by name","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}],"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},"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},"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. Use to filter by 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":"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},{"doc_url":"/apidoc/v2/packages/thindex","name":"thindex","apis":[{"api_url":"/katello/api/packages/thindex","http_method":"GET","short_description":"List all packages unique by name","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}],"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, rhel-10\u003c/p\u003e\n","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 used for published repository contents. Supported types: sha256, sha384, sha512\u003c/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 deb, docker, file and yum 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\u003eUpstream authentication token string for yum repositories.\u003c/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":"depth","full_name":"depth","description":"\n\u003cp\u003eAn option to specify how many ostree commits to traverse.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude_refs","full_name":"exclude_refs","description":"\n\u003cp\u003eA comma-separated list of tags to exclude during an ostree sync. The wildcards *, ? are recognized. \u0026#39;exclude_refs\u0026#39; is evaluated after \u0026#39;include_refs\u0026#39;.\u003c/p\u003e\n","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_refs","full_name":"include_refs","description":"\n\u003cp\u003eA comma-separated list of refs to include during an ostree sync. The wildcards *, ? are recognized.\u003c/p\u003e\n","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":"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":"keep_latest_packages","full_name":"keep_latest_packages","description":"\n\u003cp\u003eThe amount of latest versions of a package to keep on sync, includes pre-releases if synced. Default 0 keeps all versions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","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":"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, rhel-10\u003c/p\u003e\n","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 used for published repository contents. Supported types: sha256, sha384, sha512\u003c/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 deb, docker, file and yum 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\u003eUpstream authentication token string for yum repositories.\u003c/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":"depth","full_name":"depth","description":"\n\u003cp\u003eAn option to specify how many ostree commits to traverse.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude_refs","full_name":"exclude_refs","description":"\n\u003cp\u003eA comma-separated list of tags to exclude during an ostree sync. The wildcards *, ? are recognized. \u0026#39;exclude_refs\u0026#39; is evaluated after \u0026#39;include_refs\u0026#39;.\u003c/p\u003e\n","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_refs","full_name":"include_refs","description":"\n\u003cp\u003eA comma-separated list of refs to include during an ostree sync. The wildcards *, ? are recognized.\u003c/p\u003e\n","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":"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":"keep_latest_packages","full_name":"keep_latest_packages","description":"\n\u003cp\u003eThe amount of latest versions of a package to keep on sync, includes pre-releases if synced. Default 0 keeps all versions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","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":"This endpoint is primarily designed for UI interactions and uploading content into the repository. For API-based uploads, please use the 'content_uploads' endpoint instead.","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\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":true},{"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},"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},"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}]}],"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/hosts","name":"hosts","apis":[{"api_url":"/api/job_invocations/:id/hosts","http_method":"GET","short_description":"List hosts 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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 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":{"search":[{"name":"description","type":"string"},{"name":"ended_at","type":"datetime"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"job_category","type":"string"},{"name":"owner","type":"string"},{"name":"pattern_template_name","type":"string"},{"name":"recurring","values":["true","false"]},{"name":"recurring_logic.id","type":"integer"},{"name":"recurring_logic.purpose","type":"string"},{"name":"start_at","type":"datetime"},{"name":"started_at","type":"datetime"},{"name":"status","values":["succeeded","failed","queued","running","cancelled"]},{"name":"targeted_host_id","type":"string"},{"name":"user","type":"string"}]},"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 or matching tasks 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},{"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},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch query to cancel tasks only on matching hosts. If not provided, the whole job invocation will be cancelled.\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_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},{"name":"succeeded_only","full_name":"succeeded_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},"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":"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}]},{"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.","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}]}],"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.","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}]}],"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},"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},"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}}}} \ No newline at end of file diff --git a/tests/test_playbooks/content_view.yml b/tests/test_playbooks/content_view.yml index bbb8e82d02..36a5069105 100644 --- a/tests/test_playbooks/content_view.yml +++ b/tests/test_playbooks/content_view.yml @@ -23,6 +23,22 @@ vars: product_name: "Test Product 2" repository_state: present + - include_tasks: tasks/lifecycle_environment.yml + vars: + lifecycle_environment_state: present + lifecycle_environment_name: "{{ item.name }}" + lifecycle_environment_label: "{{ item.label }}" + lifecycle_environment_prior: "{{ item.prior }}" + loop: + - name: Test + label: test + prior: Library + - name: QA + label: qa + prior: Test + - name: Prod + label: prod + prior: QA - include_tasks: tasks/content_view.yml vars: content_view_name: "Test Composite Content View" @@ -214,6 +230,10 @@ vars: content_view_state: present expected_change: true + lifecycle_environments: + - QA + - Test + - Prod rolling: true repositories: - name: "Test Repository" @@ -225,6 +245,10 @@ vars: content_view_state: present expected_change: false + lifecycle_environments: + - QA + - Prod + - Test rolling: true repositories: - name: "Test Repository" @@ -233,6 +257,10 @@ vars: content_view_state: absent expected_change: true + lifecycle_environments: + - Test + - QA + - Prod rolling: true repositories: - name: "Test Repository" diff --git a/tests/test_playbooks/fixtures/content_view-0.yml b/tests/test_playbooks/fixtures/content_view-0.yml index 278f2c6e96..26b94e307d 100644 --- a/tests/test_playbooks/fixtures/content_view-0.yml +++ b/tests/test_playbooks/fixtures/content_view-0.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,10 +127,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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,10 +139,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-Length: + - '170' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -151,27 +148,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '157' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -187,14 +186,13 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/products?search=name%3D%22Test+Product%22&per_page=4294967296 response: body: - string: '{"total":2,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":18,"cp_id":"956117903760","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":25,"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":"2020-09-14 - 10:19:27 UTC","last_sync_words":"less than a minute","organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"sync_plan":null,"repository_count":1}]} + string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":1,"cp_id":"624377688211","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":3,"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":null,"last_sync_words":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":1}]} ' headers: @@ -202,10 +200,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-Length: + - '625' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -213,27 +209,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '653' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -249,15 +247,16 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/18/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/1/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":"1819fd9f-8231-43ee-9132-a87a073ba3d7","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"http://centos7-katello-3-16.yatsu.example.com/pulp/repos/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"id":30,"name":"Test - Repository","label":"Test_Repository","description":null,"last_sync":null,"content_view":{"id":29,"name":"Default - Organization View"},"content_view_version":{"id":18,"name":"Default Organization - View 1.0","content_view_id":29},"kt_environment":{"id":13,"name":"Library"},"content_type":"yum","url":null,"arch":"noarch","content_id":"1600078766677","major":null,"minor":null,"product":{"id":18,"cp_id":"956117903760","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":"f5cc71fb-3e1f-48d2-8db4-68349096758f","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,"full_gpg_key_path":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/0197fa14-1de9-7a8c-ac85-fff97edefbdd/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/0197fa14-239a-7acb-a6b3-ba44220d968c/","content_counts":{"rpm":0,"erratum":0,"package_group":0,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":1,"name":"Test + Repository","label":"Test_Repository","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"content_view_versions":[],"filters":[],"last_sync":null,"content_view":{"id":2,"name":"Default + Organization View"},"content_view_version":{"id":2,"name":"Default Organization + View 1.0","content_view_id":2},"kt_environment":{"id":2,"name":"Library"},"content_type":"yum","url":null,"docker_upstream_name":null,"arch":"noarch","os_versions":[],"content_id":"1752247312252","generic_remote_options":null,"major":null,"minor":null,"product":{"id":1,"cp_id":"624377688211","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":2} ' headers: @@ -265,10 +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-Length: + - '1679' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -278,30 +275,32 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1319' + x-xss-protection: + - '0' status: code: 200 message: OK - request: - body: '{"name": "Test Content View", "composite": false, "repository_ids": [30], + body: '{"name": "Test Content View", "composite": false, "repository_ids": [1], "auto_publish": false}' headers: Accept: @@ -311,20 +310,20 @@ interactions: Connection: - keep-alive Content-Length: - - '96' + - '95' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/organizations/14/content_views + uri: https://foreman.example.org/katello/api/organizations/3/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,"repository_ids":[30],"id":30,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:35 UTC","updated_at":"2020-09-14 10:19:35 UTC","environments":[],"repositories":[{"id":30,"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":[]} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":3,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:07 UTC","updated_at":"2025-07-11 15:22:07 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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":[],"errors":null} ' headers: @@ -332,10 +331,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-Length: + - '991' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -343,25 +340,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Transfer-Encoding: - - chunked - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 201 message: Created diff --git a/tests/test_playbooks/fixtures/content_view-1.yml b/tests/test_playbooks/fixtures/content_view-1.yml index 5994f53666..60cbeb397a 100644 --- a/tests/test_playbooks/fixtures/content_view-1.yml +++ b/tests/test_playbooks/fixtures/content_view-1.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,15 +127,15 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 response: body: - string: '{"total":2,"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,"repository_ids":[30],"id":30,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:35 UTC","updated_at":"2020-09-14 10:19:35 UTC","environments":[],"repositories":[{"id":30,"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":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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":3,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:07 UTC","updated_at":"2025-07-11 15:22:07 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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,10 +143,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-Length: + - '1121' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -155,27 +152,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1040' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -191,14 +190,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/30 + uri: https://foreman.example.org/katello/api/content_views/3 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,"repository_ids":[30],"id":30,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:35 UTC","updated_at":"2020-09-14 10:19:35 UTC","environments":[],"repositories":[{"id":30,"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":[]} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":3,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:07 UTC","updated_at":"2025-07-11 15:22:07 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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":[],"errors":null} ' headers: @@ -206,10 +205,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-Length: + - '991' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -219,25 +216,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '948' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -253,14 +252,13 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/products?search=name%3D%22Test+Product%22&per_page=4294967296 response: body: - string: '{"total":2,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":18,"cp_id":"956117903760","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":25,"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":"2020-09-14 - 10:19:27 UTC","last_sync_words":"less than a minute","organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"sync_plan":null,"repository_count":1}]} + string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":1,"cp_id":"624377688211","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":3,"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":null,"last_sync_words":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":1}]} ' headers: @@ -268,10 +266,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-Length: + - '625' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -279,27 +275,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '653' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -315,15 +313,16 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/18/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/1/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":"1819fd9f-8231-43ee-9132-a87a073ba3d7","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"http://centos7-katello-3-16.yatsu.example.com/pulp/repos/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"id":30,"name":"Test - Repository","label":"Test_Repository","description":null,"last_sync":null,"content_view":{"id":29,"name":"Default - Organization View"},"content_view_version":{"id":18,"name":"Default Organization - View 1.0","content_view_id":29},"kt_environment":{"id":13,"name":"Library"},"content_type":"yum","url":null,"arch":"noarch","content_id":"1600078766677","major":null,"minor":null,"product":{"id":18,"cp_id":"956117903760","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":"f5cc71fb-3e1f-48d2-8db4-68349096758f","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,"full_gpg_key_path":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/0197fa14-1de9-7a8c-ac85-fff97edefbdd/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/0197fa14-239a-7acb-a6b3-ba44220d968c/","content_counts":{"rpm":0,"erratum":0,"package_group":0,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":1,"name":"Test + Repository","label":"Test_Repository","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"content_view_versions":[],"filters":[],"last_sync":null,"content_view":{"id":2,"name":"Default + Organization View"},"content_view_version":{"id":2,"name":"Default Organization + View 1.0","content_view_id":2},"kt_environment":{"id":2,"name":"Library"},"content_type":"yum","url":null,"docker_upstream_name":null,"arch":"noarch","os_versions":[],"content_id":"1752247312252","generic_remote_options":null,"major":null,"minor":null,"product":{"id":1,"cp_id":"624377688211","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":2} ' headers: @@ -331,10 +330,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-Length: + - '1679' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -344,25 +341,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1319' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-10.yml b/tests/test_playbooks/fixtures/content_view-10.yml index cde1485867..959793b00c 100644 --- a/tests/test_playbooks/fixtures/content_view-10.yml +++ b/tests/test_playbooks/fixtures/content_view-10.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,24 +127,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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 + Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:27 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -153,10 +153,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-Length: + - '2438' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -164,27 +162,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2248' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -200,23 +200,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 response: body: - string: ' {"content_host_count":0,"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:27 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -224,10 +225,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-Length: + - '2298' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -237,25 +236,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2146' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -271,17 +272,20 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[{"id":5,"name":"Test + Composite Content View"}],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}]}]} ' headers: @@ -289,10 +293,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-Length: + - '1644' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -300,27 +302,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1224' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -336,16 +340,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/31 + uri: https://foreman.example.org/katello/api/content_views/4 response: body: - string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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":[]} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[{"id":5,"name":"Test + Composite Content View"}],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} ' headers: @@ -353,10 +360,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-Length: + - '1514' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -366,25 +371,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1132' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -404,16 +411,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: PUT - uri: https://foreman.example.org/katello/api/content_views/32/content_view_components/6 + uri: https://foreman.example.org/katello/api/content_views/5/content_view_components/1 response: body: - string: ' {"latest":true,"id":6,"created_at":"2020-09-14 10:19:50 UTC","updated_at":"2020-09-14 - 10:19:55 UTC","composite_content_view":{"id":32,"name":"Test Composite Content - View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}} + string: ' {"latest":true,"id":1,"created_at":"2025-07-11 15:22:27 UTC","updated_at":"2025-07-11 + 15:22:33 UTC","composite_content_view":{"id":5,"name":"Test Composite Content + View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]} ' headers: @@ -421,10 +429,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-Length: + - '920' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -434,25 +440,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=94 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '805' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-11.yml b/tests/test_playbooks/fixtures/content_view-11.yml index feabbd1e18..b60b84f2c8 100644 --- a/tests/test_playbooks/fixtures/content_view-11.yml +++ b/tests/test_playbooks/fixtures/content_view-11.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,24 +127,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:55 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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 + Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:33 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -153,10 +153,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-Length: + - '2437' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -164,27 +162,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2247' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -200,23 +200,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 response: body: - string: ' {"content_host_count":0,"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:55 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:33 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -224,10 +225,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-Length: + - '2297' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -237,25 +236,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2145' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -271,17 +272,20 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[{"id":5,"name":"Test + Composite Content View"}],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}]}]} ' headers: @@ -289,10 +293,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-Length: + - '1644' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -300,27 +302,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1224' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -336,16 +340,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/31 + uri: https://foreman.example.org/katello/api/content_views/4 response: body: - string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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":[]} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[{"id":5,"name":"Test + Composite Content View"}],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} ' headers: @@ -353,10 +360,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-Length: + - '1514' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -366,25 +371,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1132' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-12.yml b/tests/test_playbooks/fixtures/content_view-12.yml index d1f500f1b1..f48000b8c5 100644 --- a/tests/test_playbooks/fixtures/content_view-12.yml +++ b/tests/test_playbooks/fixtures/content_view-12.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,24 +127,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:55 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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 + Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:33 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -153,10 +153,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-Length: + - '2437' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -164,27 +162,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2247' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -200,23 +200,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 response: body: - string: ' {"content_host_count":0,"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:55 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:33 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -224,10 +225,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-Length: + - '2297' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -237,25 +236,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2145' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-13.yml b/tests/test_playbooks/fixtures/content_view-13.yml index cffaea54a0..6915a07252 100644 --- a/tests/test_playbooks/fixtures/content_view-13.yml +++ b/tests/test_playbooks/fixtures/content_view-13.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,24 +127,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:55 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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 + Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:33 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -153,10 +153,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-Length: + - '2437' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -164,27 +162,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2247' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -200,23 +200,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 response: body: - string: ' {"content_host_count":0,"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:55 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":true,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:33 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -224,10 +225,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-Length: + - '2297' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -237,30 +236,32 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2145' + x-xss-protection: + - '0' status: code: 200 message: OK - request: - body: '{"component_ids": [6]}' + body: '{"component_ids": [1]}' headers: Accept: - application/json;version=2 @@ -275,10 +276,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: PUT - uri: https://foreman.example.org/katello/api/content_views/32/content_view_components/remove + uri: https://foreman.example.org/katello/api/content_views/5/content_view_components/remove response: body: - string: '{"total":0,"subtotal":0,"page":null,"per_page":null,"error":null,"search":null,"sort":{"by":null,"order":null},"results":[]} + string: '{"total":0,"subtotal":0,"selectable":0,"page":null,"per_page":null,"error":null,"search":null,"sort":{"by":null,"order":null},"results":[]} ' headers: @@ -286,10 +287,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-Length: + - '140' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -299,25 +298,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '125' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-14.yml b/tests/test_playbooks/fixtures/content_view-14.yml index b6e8a47268..3980c232e4 100644 --- a/tests/test_playbooks/fixtures/content_view-14.yml +++ b/tests/test_playbooks/fixtures/content_view-14.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,14 +127,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 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}}]} + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Test + Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -143,10 +142,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-Length: + - '1068' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -154,27 +151,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '985' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -190,13 +189,13 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 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":true,"solve_dependencies":false,"repository_ids":[],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -204,10 +203,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-Length: + - '928' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -217,25 +214,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '883' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-15.yml b/tests/test_playbooks/fixtures/content_view-15.yml index b6e8a47268..3980c232e4 100644 --- a/tests/test_playbooks/fixtures/content_view-15.yml +++ b/tests/test_playbooks/fixtures/content_view-15.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,14 +127,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 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}}]} + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Test + Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -143,10 +142,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-Length: + - '1068' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -154,27 +151,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '985' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -190,13 +189,13 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 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":true,"solve_dependencies":false,"repository_ids":[],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -204,10 +203,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-Length: + - '928' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -217,25 +214,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '883' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-16.yml b/tests/test_playbooks/fixtures/content_view-16.yml index 06cd3fdf23..8ea4517c74 100644 --- a/tests/test_playbooks/fixtures/content_view-16.yml +++ b/tests/test_playbooks/fixtures/content_view-16.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,14 +127,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 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}}]} + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Test + Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -143,10 +142,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-Length: + - '1068' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -154,27 +151,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '985' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -190,13 +189,13 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 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":true,"solve_dependencies":false,"repository_ids":[],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -204,10 +203,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-Length: + - '928' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -217,25 +214,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '883' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -253,17 +252,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: DELETE - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 response: body: - string: ' {"id":"e0a55fcd-b41d-4a16-992e-02e62680b7cf","label":"Actions::Katello::ContentView::Destroy","pending":true,"action":"Delete - content view ''Test Composite Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:20:00 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content - view ''Test Composite Content View''","link":"/content_views/32/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:20:00 UTC","available_actions":{"cancellable":false,"resumable":false}} + string: ' {"id":"07cd27a8-a30e-4bc7-ae1b-45b2083b37f9","label":"Actions::Katello::ContentView::Destroy","pending":true,"action":"Delete + content view ''Test Composite Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:41 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":"4a17c9a6-753d-4444-8a46-32ab1e71d8e2","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content + view ''Test Composite Content View''","link":"/content_views/5/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:41 UTC","available_actions":{"cancellable":false,"resumable":false}} ' headers: @@ -271,10 +270,6 @@ interactions: - no-cache 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: @@ -284,23 +279,29 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains + Referrer-Policy: + - strict-origin-when-cross-origin Transfer-Encoding: - chunked - X-Content-Type-Options: + content-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''' + strict-transport-security: + - max-age=631139040; includeSubdomains + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 202 message: Accepted @@ -316,26 +317,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/foreman_tasks/api/tasks/e0a55fcd-b41d-4a16-992e-02e62680b7cf + uri: https://foreman.example.org/foreman_tasks/api/tasks/07cd27a8-a30e-4bc7-ae1b-45b2083b37f9 response: body: - string: '{"id":"e0a55fcd-b41d-4a16-992e-02e62680b7cf","label":"Actions::Katello::ContentView::Destroy","pending":false,"action":"Delete - content view ''Test Composite Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:20:00 UTC","ended_at":"2020-09-14 10:20:00 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content - view ''Test Composite Content View''","link":"/content_views/32/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:20:00 UTC","available_actions":{"cancellable":false,"resumable":false}}' + string: '{"id":"07cd27a8-a30e-4bc7-ae1b-45b2083b37f9","label":"Actions::Katello::ContentView::Destroy","pending":false,"action":"Delete + content view ''Test Composite Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:41 UTC","ended_at":"2025-07-11 15:22:42 UTC","duration":"0.222763","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":"4a17c9a6-753d-4444-8a46-32ab1e71d8e2","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content + view ''Test Composite Content View''","link":"/content_views/5/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:41 UTC","available_actions":{"cancellable":false,"resumable":false}}' headers: Cache-Control: - 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-Length: + - '1193' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -345,25 +344,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1141' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-17.yml b/tests/test_playbooks/fixtures/content_view-17.yml index 68b746cdc2..c0d19de98e 100644 --- a/tests/test_playbooks/fixtures/content_view-17.yml +++ b/tests/test_playbooks/fixtures/content_view-17.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,10 +127,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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,10 +139,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-Length: + - '180' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -151,27 +148,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '167' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-18.yml b/tests/test_playbooks/fixtures/content_view-18.yml index 3cba689f3d..21a6fef5c4 100644 --- a/tests/test_playbooks/fixtures/content_view-18.yml +++ b/tests/test_playbooks/fixtures/content_view-18.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,17 +127,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 response: body: - string: '{"total":2,"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":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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":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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}]}]} ' headers: @@ -146,10 +147,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-Length: + - '1599' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -157,27 +156,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1224' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -193,16 +194,18 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/31 + uri: https://foreman.example.org/katello/api/content_views/4 response: body: - string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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":[]} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} ' headers: @@ -210,10 +213,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-Length: + - '1469' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -223,25 +224,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1132' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -259,18 +262,18 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: DELETE - uri: https://foreman.example.org/katello/api/content_views/31/environments/13 + uri: https://foreman.example.org/katello/api/content_views/4/environments/2 response: body: - string: ' {"id":"c37fd5ef-a2ab-48e6-b832-9d857012b371","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":true,"action":"Remove - from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:20:06 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":25,"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{},"humanized":{"action":"Remove + string: ' {"id":"92e18900-63f9-40d8-9df0-c7020c72df91","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":true,"action":"Remove + from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:48 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":2,"current_request_id":"c75ed979-93ac-4e12-9bb6-3e879eab1a4e","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Remove from Environment","input":[["content_view",{"text":"content view ''Test Content - View''","link":"/content_views/31/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:20:06 UTC","available_actions":{"cancellable":false,"resumable":false}} + View''","link":"/content_views/4/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:48 UTC","available_actions":{"cancellable":false,"resumable":false}} ' headers: @@ -278,10 +281,6 @@ interactions: - no-cache 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: @@ -291,23 +290,29 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains + Referrer-Policy: + - strict-origin-when-cross-origin Transfer-Encoding: - chunked - X-Content-Type-Options: + content-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''' + strict-transport-security: + - max-age=631139040; includeSubdomains + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 202 message: Accepted @@ -323,27 +328,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/foreman_tasks/api/tasks/c37fd5ef-a2ab-48e6-b832-9d857012b371 + uri: https://foreman.example.org/foreman_tasks/api/tasks/92e18900-63f9-40d8-9df0-c7020c72df91 response: body: - string: '{"id":"c37fd5ef-a2ab-48e6-b832-9d857012b371","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":false,"action":"Remove - from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:20:06 UTC","ended_at":"2020-09-14 10:20:06 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":25,"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{},"humanized":{"action":"Remove + string: '{"id":"92e18900-63f9-40d8-9df0-c7020c72df91","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":false,"action":"Remove + from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:48 UTC","ended_at":"2025-07-11 15:22:49 UTC","duration":"0.896691","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":2,"current_request_id":"c75ed979-93ac-4e12-9bb6-3e879eab1a4e","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Remove from Environment","input":[["content_view",{"text":"content view ''Test Content - View''","link":"/content_views/31/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:20:06 UTC","available_actions":{"cancellable":false,"resumable":false}}' + View''","link":"/content_views/4/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:48 UTC","available_actions":{"cancellable":false,"resumable":false}}' headers: Cache-Control: - 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-Length: + - '1198' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -353,25 +356,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1147' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -389,17 +394,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: DELETE - uri: https://foreman.example.org/katello/api/content_views/31 + uri: https://foreman.example.org/katello/api/content_views/4 response: body: - string: ' {"id":"8f3a3c07-2e46-48ff-9faa-75d2a0a70269","label":"Actions::Katello::ContentView::Destroy","pending":true,"action":"Delete - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:20:10 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3","pulp","pulp_auth"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content - view ''Test Content View''","link":"/content_views/31/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:20:10 UTC","available_actions":{"cancellable":false,"resumable":false}} + string: ' {"id":"16a5e456-92f7-4f34-b166-6339bee69df1","label":"Actions::Katello::ContentView::Destroy","pending":true,"action":"Delete + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:52 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":"d5db2a94-c0c3-412c-ab5a-ca0e791e639a","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/4/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:52 UTC","available_actions":{"cancellable":false,"resumable":false}} ' headers: @@ -407,10 +412,6 @@ interactions: - no-cache 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: @@ -420,23 +421,29 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=94 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains + Referrer-Policy: + - strict-origin-when-cross-origin Transfer-Encoding: - chunked - X-Content-Type-Options: + content-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''' + strict-transport-security: + - max-age=631139040; includeSubdomains + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 202 message: Accepted @@ -452,26 +459,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/foreman_tasks/api/tasks/8f3a3c07-2e46-48ff-9faa-75d2a0a70269 + uri: https://foreman.example.org/foreman_tasks/api/tasks/16a5e456-92f7-4f34-b166-6339bee69df1 response: body: - string: '{"id":"8f3a3c07-2e46-48ff-9faa-75d2a0a70269","label":"Actions::Katello::ContentView::Destroy","pending":false,"action":"Delete - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:20:10 UTC","ended_at":"2020-09-14 10:20:12 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3","pulp","pulp_auth"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content - view ''Test Content View''","link":"/content_views/31/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:20:10 UTC","available_actions":{"cancellable":false,"resumable":false}}' + string: '{"id":"16a5e456-92f7-4f34-b166-6339bee69df1","label":"Actions::Katello::ContentView::Destroy","pending":false,"action":"Delete + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:52 UTC","ended_at":"2025-07-11 15:22:54 UTC","duration":"2.093612","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":"d5db2a94-c0c3-412c-ab5a-ca0e791e639a","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/4/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:52 UTC","available_actions":{"cancellable":false,"resumable":false}}' headers: Cache-Control: - 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-Length: + - '1153' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -481,25 +486,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=93 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1120' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-19.yml b/tests/test_playbooks/fixtures/content_view-19.yml index 47cfe4cefc..cde7a92f82 100644 --- a/tests/test_playbooks/fixtures/content_view-19.yml +++ b/tests/test_playbooks/fixtures/content_view-19.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,10 +127,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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,10 +139,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-Length: + - '170' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -151,27 +148,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '157' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-2.yml b/tests/test_playbooks/fixtures/content_view-2.yml index e9d07166ce..2f8f9f3148 100644 --- a/tests/test_playbooks/fixtures/content_view-2.yml +++ b/tests/test_playbooks/fixtures/content_view-2.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,15 +127,15 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 response: body: - string: '{"total":2,"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,"repository_ids":[30],"id":30,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:35 UTC","updated_at":"2020-09-14 10:19:35 UTC","environments":[],"repositories":[{"id":30,"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":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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":3,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:07 UTC","updated_at":"2025-07-11 15:22:07 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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,10 +143,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-Length: + - '1121' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -155,27 +152,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1040' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -191,14 +190,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/30 + uri: https://foreman.example.org/katello/api/content_views/3 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,"repository_ids":[30],"id":30,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:35 UTC","updated_at":"2020-09-14 10:19:35 UTC","environments":[],"repositories":[{"id":30,"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":[]} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":3,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:07 UTC","updated_at":"2025-07-11 15:22:07 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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":[],"errors":null} ' headers: @@ -206,10 +205,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-Length: + - '991' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -219,25 +216,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '948' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -255,17 +254,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: DELETE - uri: https://foreman.example.org/katello/api/content_views/30 + uri: https://foreman.example.org/katello/api/content_views/3 response: body: - string: ' {"id":"78ac542c-da51-44e7-bdeb-673a6fad2dc0","label":"Actions::Katello::ContentView::Destroy","pending":true,"action":"Delete - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:19:37 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":30,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content - view ''Test Content View''","link":"/content_views/30/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:19:37 UTC","available_actions":{"cancellable":false,"resumable":false}} + string: ' {"id":"0544a101-e9ae-4a15-8e99-af6943c379bf","label":"Actions::Katello::ContentView::Destroy","pending":true,"action":"Delete + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:11 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":3,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":"7a8d3171-2c07-4672-8ec7-4e001fcdc233","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/3/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:11 UTC","available_actions":{"cancellable":false,"resumable":false}} ' headers: @@ -273,10 +272,6 @@ interactions: - no-cache 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: @@ -286,23 +281,29 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains + Referrer-Policy: + - strict-origin-when-cross-origin Transfer-Encoding: - chunked - X-Content-Type-Options: + content-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''' + strict-transport-security: + - max-age=631139040; includeSubdomains + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 202 message: Accepted @@ -318,26 +319,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/foreman_tasks/api/tasks/78ac542c-da51-44e7-bdeb-673a6fad2dc0 + uri: https://foreman.example.org/foreman_tasks/api/tasks/0544a101-e9ae-4a15-8e99-af6943c379bf response: body: - string: '{"id":"78ac542c-da51-44e7-bdeb-673a6fad2dc0","label":"Actions::Katello::ContentView::Destroy","pending":false,"action":"Delete - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:19:37 UTC","ended_at":"2020-09-14 10:19:37 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":30,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content - view ''Test Content View''","link":"/content_views/30/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:19:37 UTC","available_actions":{"cancellable":false,"resumable":false}}' + string: '{"id":"0544a101-e9ae-4a15-8e99-af6943c379bf","label":"Actions::Katello::ContentView::Destroy","pending":false,"action":"Delete + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:11 UTC","ended_at":"2025-07-11 15:22:11 UTC","duration":"0.385225","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":3,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":"7a8d3171-2c07-4672-8ec7-4e001fcdc233","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/3/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:11 UTC","available_actions":{"cancellable":false,"resumable":false}}' headers: Cache-Control: - 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-Length: + - '1153' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -347,25 +346,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1101' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-20.yml b/tests/test_playbooks/fixtures/content_view-20.yml index 2da39f3fe6..4471c8c810 100644 --- a/tests/test_playbooks/fixtures/content_view-20.yml +++ b/tests/test_playbooks/fixtures/content_view-20.yml @@ -72,8 +72,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\":\"2025-06-05 - 07:17:51 UTC\",\"updated_at\":\"2025-06-05 07:17:54 UTC\",\"id\":3,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -190,7 +190,7 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":1,"cp_id":"605901456311","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":1,"cp_id":"624377688211","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":3,"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":null,"last_sync_words":null,"organization_id":3,"organization":{"name":"Test Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":1}]} @@ -251,11 +251,11 @@ interactions: response: body: 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":"bd286c90-c6a6-4e1a-a1c6-05f30b990e9d","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,"full_gpg_key_path":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/01973ef4-2a9e-797e-875d-f04d0f44b7c7/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/01973ef4-2e69-7e69-b1a9-8bb0ee3e2632/","content_counts":{"rpm":0,"erratum":0,"package_group":0,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":1,"name":"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"f5cc71fb-3e1f-48d2-8db4-68349096758f","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,"full_gpg_key_path":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/0197fa14-1de9-7a8c-ac85-fff97edefbdd/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/0197fa14-239a-7acb-a6b3-ba44220d968c/","content_counts":{"rpm":0,"erratum":0,"package_group":0,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":1,"name":"Test Repository","label":"Test_Repository","description":null,"organization_id":3,"organization":{"name":"Test Organization","label":"Test_Organization","id":3},"content_view_versions":[],"filters":[],"last_sync":null,"content_view":{"id":2,"name":"Default Organization View"},"content_view_version":{"id":2,"name":"Default Organization - View 1.0","content_view_id":2},"kt_environment":{"id":2,"name":"Library"},"content_type":"yum","url":null,"docker_upstream_name":null,"arch":"noarch","os_versions":[],"content_id":"1749107878842","generic_remote_options":null,"major":null,"minor":null,"product":{"id":1,"cp_id":"605901456311","name":"Test + View 1.0","content_view_id":2},"kt_environment":{"id":2,"name":"Library"},"content_type":"yum","url":null,"docker_upstream_name":null,"arch":"noarch","os_versions":[],"content_id":"1752247312252","generic_remote_options":null,"major":null,"minor":null,"product":{"id":1,"cp_id":"624377688211","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":2} ' @@ -299,9 +299,189 @@ 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/environments?search=name%3D%22QA%22&per_page=4294967296 + response: + body: + string: '{"total":5,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"QA\"","sort":{"by":"name","order":"asc"},"results":[{"library":false,"registry_name_pattern":null,"registry_unauthenticated_pull":false,"id":4,"name":"QA","label":"qa","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:01 UTC","updated_at":"2025-07-11 15:22:01 UTC","prior":{"name":"Test","id":3},"successor":{"name":"Prod","id":5},"counts":{"content_hosts":0,"content_views":0},"permissions":{"create_lifecycle_environments":true,"view_lifecycle_environments":true,"edit_lifecycle_environments":true,"destroy_lifecycle_environments":true,"promote_or_remove_content_views_to_environments":true},"content_views":[],"capsules":[{"id":1,"name":"foreman.example.com","lifecycle_environments":[{"id":1},{"id":2},{"id":3},{"id":4},{"id":5}]}]}]} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '938' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.16.0-develop + Keep-Alive: + - timeout=15, max=95 + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + 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: + - '0' + 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/environments?search=name%3D%22Test%22&per_page=4294967296 + response: + body: + string: '{"total":5,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Test\"","sort":{"by":"name","order":"asc"},"results":[{"library":false,"registry_name_pattern":null,"registry_unauthenticated_pull":false,"id":3,"name":"Test","label":"test","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:00 UTC","updated_at":"2025-07-11 15:22:00 UTC","prior":{"name":"Library","id":2},"successor":{"name":"QA","id":4},"counts":{"content_hosts":0,"content_views":0},"permissions":{"create_lifecycle_environments":true,"view_lifecycle_environments":true,"edit_lifecycle_environments":true,"destroy_lifecycle_environments":true,"promote_or_remove_content_views_to_environments":true},"content_views":[],"capsules":[{"id":1,"name":"foreman.example.com","lifecycle_environments":[{"id":1},{"id":2},{"id":3},{"id":4},{"id":5}]}]}]} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '945' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.16.0-develop + Keep-Alive: + - timeout=15, max=94 + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + 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: + - '0' + 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/environments?search=name%3D%22Prod%22&per_page=4294967296 + response: + body: + string: '{"total":5,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Prod\"","sort":{"by":"name","order":"asc"},"results":[{"library":false,"registry_name_pattern":null,"registry_unauthenticated_pull":false,"id":5,"name":"Prod","label":"prod","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:02 UTC","updated_at":"2025-07-11 15:22:02 UTC","prior":{"name":"QA","id":4},"successor":null,"counts":{"content_hosts":0,"content_views":0},"permissions":{"create_lifecycle_environments":true,"view_lifecycle_environments":true,"edit_lifecycle_environments":true,"destroy_lifecycle_environments":true,"promote_or_remove_content_views_to_environments":true},"content_views":[],"capsules":[{"id":1,"name":"foreman.example.com","lifecycle_environments":[{"id":1},{"id":2},{"id":3},{"id":4},{"id":5}]}]}]} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '924' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.16.0-develop + Keep-Alive: + - timeout=15, max=93 + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + 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: + - '0' + status: + code: 200 + message: OK - request: body: '{"name": "Test Content View", "composite": false, "rolling": true, "repository_ids": - [1], "auto_publish": false}' + [1], "environment_ids": [3, 4, 5], "auto_publish": false}' headers: Accept: - application/json;version=2 @@ -310,7 +490,7 @@ interactions: Connection: - keep-alive Content-Length: - - '112' + - '142' Content-Type: - application/json User-Agent: @@ -319,14 +499,14 @@ interactions: uri: https://foreman.example.org/katello/api/organizations/3/content_views response: body: - string: ' {"content_host_count":0,"composite":false,"rolling":true,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":4,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"repository_ids":[1],"id":6,"name":"Test + string: ' {"content_host_count":0,"composite":false,"rolling":true,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":4,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"environment_ids":[3,4,5],"repository_ids":[1],"id":6,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test - Organization","label":"Test_Organization","id":3},"created_at":"2025-06-05 - 07:18:55 UTC","updated_at":"2025-06-05 07:18:55 UTC","last_task":null,"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":4,"version":"1.0","published":"2025-06-05 - 07:18:55 UTC","description":null,"environment_ids":[2],"filters_applied":null,"published_at_words":"less - than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-06-05 - 07:18:55 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:23:00 UTC","updated_at":"2025-07-11 15:23:00 UTC","last_task":null,"latest_version_environments":[{"id":3,"name":"Test","label":"test"},{"id":4,"name":"QA","label":"qa"},{"id":5,"name":"Prod","label":"prod"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":4,"version":"1.0","published":"2025-07-11 + 15:23:00 UTC","description":null,"environment_ids":[3,4,5],"filters_applied":null,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:23:00 UTC","environments":[{"id":3,"label":"test","name":"Test","activation_keys":[],"hosts":[],"permissions":{"readable":true}},{"id":4,"label":"qa","name":"QA","activation_keys":[],"hosts":[],"permissions":{"readable":true}},{"id":5,"label":"prod","name":"Prod","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} ' headers: @@ -335,7 +515,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1307' + - '1597' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -347,7 +527,7 @@ interactions: Foreman_version: - 3.16.0-develop Keep-Alive: - - timeout=15, max=95 + - timeout=15, max=92 Referrer-Policy: - strict-origin-when-cross-origin content-security-policy: diff --git a/tests/test_playbooks/fixtures/content_view-21.yml b/tests/test_playbooks/fixtures/content_view-21.yml index 8a1363ac5f..75b06e8d2d 100644 --- a/tests/test_playbooks/fixtures/content_view-21.yml +++ b/tests/test_playbooks/fixtures/content_view-21.yml @@ -72,8 +72,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\":\"2025-06-05 - 07:17:51 UTC\",\"updated_at\":\"2025-06-05 07:17:54 UTC\",\"id\":3,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -131,14 +131,14 @@ 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,"rolling":true,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":4,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"repository_ids":[1],"id":6,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"rolling":true,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":4,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"environment_ids":[3,4,5],"repository_ids":[1],"id":6,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test - Organization","label":"Test_Organization","id":3},"created_at":"2025-06-05 - 07:18:55 UTC","updated_at":"2025-06-05 07:18:55 UTC","last_task":null,"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":4,"version":"1.0","published":"2025-06-05 - 07:18:55 UTC","description":null,"environment_ids":[2],"filters_applied":null,"published_at_words":"less - than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-06-05 - 07:18:55 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}]}]} + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:23:00 UTC","updated_at":"2025-07-11 15:23:00 UTC","last_task":null,"latest_version_environments":[{"id":3,"name":"Test","label":"test"},{"id":4,"name":"QA","label":"qa"},{"id":5,"name":"Prod","label":"prod"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":4,"version":"1.0","published":"2025-07-11 + 15:23:00 UTC","description":null,"environment_ids":[3,4,5],"filters_applied":null,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:23:00 UTC","environments":[{"id":3,"label":"test","name":"Test","activation_keys":[],"hosts":[],"permissions":{"readable":true}},{"id":4,"label":"qa","name":"QA","activation_keys":[],"hosts":[],"permissions":{"readable":true}},{"id":5,"label":"prod","name":"Prod","activation_keys":[],"hosts":[],"permissions":{"readable":true}}]}]} ' headers: @@ -147,7 +147,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1437' + - '1727' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -196,14 +196,14 @@ interactions: uri: https://foreman.example.org/katello/api/content_views/6 response: body: - string: ' {"content_host_count":0,"composite":false,"rolling":true,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":4,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"repository_ids":[1],"id":6,"name":"Test + string: ' {"content_host_count":0,"composite":false,"rolling":true,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":4,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"environment_ids":[3,4,5],"repository_ids":[1],"id":6,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test - Organization","label":"Test_Organization","id":3},"created_at":"2025-06-05 - 07:18:55 UTC","updated_at":"2025-06-05 07:18:55 UTC","last_task":null,"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":4,"version":"1.0","published":"2025-06-05 - 07:18:55 UTC","description":null,"environment_ids":[2],"filters_applied":null,"published_at_words":"less - than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-06-05 - 07:18:55 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:23:00 UTC","updated_at":"2025-07-11 15:23:00 UTC","last_task":null,"latest_version_environments":[{"id":3,"name":"Test","label":"test"},{"id":4,"name":"QA","label":"qa"},{"id":5,"name":"Prod","label":"prod"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":4,"version":"1.0","published":"2025-07-11 + 15:23:00 UTC","description":null,"environment_ids":[3,4,5],"filters_applied":null,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:23:00 UTC","environments":[{"id":3,"label":"test","name":"Test","activation_keys":[],"hosts":[],"permissions":{"readable":true}},{"id":4,"label":"qa","name":"QA","activation_keys":[],"hosts":[],"permissions":{"readable":true}},{"id":5,"label":"prod","name":"Prod","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} ' headers: @@ -212,7 +212,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1307' + - '1597' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -262,7 +262,7 @@ interactions: response: body: string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":1,"cp_id":"605901456311","name":"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":1,"cp_id":"624377688211","name":"Test Product","label":"Test_Product","description":"A happy little test product","provider_id":3,"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":null,"last_sync_words":null,"organization_id":3,"organization":{"name":"Test Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":1}]} @@ -323,13 +323,13 @@ interactions: response: body: 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":"bd286c90-c6a6-4e1a-a1c6-05f30b990e9d","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,"full_gpg_key_path":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/01973ef4-2a9e-797e-875d-f04d0f44b7c7/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/01973ef4-2e69-7e69-b1a9-8bb0ee3e2632/","content_counts":{"rpm":0,"erratum":0,"package_group":0,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":1,"name":"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"f5cc71fb-3e1f-48d2-8db4-68349096758f","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,"full_gpg_key_path":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/0197fa14-1de9-7a8c-ac85-fff97edefbdd/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/0197fa14-239a-7acb-a6b3-ba44220d968c/","content_counts":{"rpm":0,"erratum":0,"package_group":0,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":1,"name":"Test Repository","label":"Test_Repository","description":null,"organization_id":3,"organization":{"name":"Test Organization","label":"Test_Organization","id":3},"content_view_versions":[{"id":4,"version":"1.0","content_view_id":6,"content_view_name":"Test Content View"}],"filters":[],"last_sync":null,"content_view":{"id":2,"name":"Default Organization View"},"content_view_version":{"id":2,"name":"Default Organization - View 1.0","content_view_id":2},"kt_environment":{"id":2,"name":"Library"},"content_type":"yum","url":null,"docker_upstream_name":null,"arch":"noarch","os_versions":[],"content_id":"1749107878842","generic_remote_options":null,"major":null,"minor":null,"product":{"id":1,"cp_id":"605901456311","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":3} + View 1.0","content_view_id":2},"kt_environment":{"id":2,"name":"Library"},"content_type":"yum","url":null,"docker_upstream_name":null,"arch":"noarch","os_versions":[],"content_id":"1752247312252","generic_remote_options":null,"major":null,"minor":null,"product":{"id":1,"cp_id":"624377688211","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":5} ' headers: @@ -372,4 +372,187 @@ 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/environments?search=name%3D%22QA%22&per_page=4294967296 + response: + body: + string: '{"total":5,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"QA\"","sort":{"by":"name","order":"asc"},"results":[{"library":false,"registry_name_pattern":null,"registry_unauthenticated_pull":false,"id":4,"name":"QA","label":"qa","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:01 UTC","updated_at":"2025-07-11 15:22:01 UTC","prior":{"name":"Test","id":3},"successor":{"name":"Prod","id":5},"counts":{"content_hosts":0,"content_views":1},"permissions":{"create_lifecycle_environments":true,"view_lifecycle_environments":true,"edit_lifecycle_environments":true,"destroy_lifecycle_environments":true,"promote_or_remove_content_views_to_environments":true},"content_views":[{"name":"Test + Content View","id":6}],"capsules":[{"id":1,"name":"foreman.example.com","lifecycle_environments":[{"id":1},{"id":2},{"id":3},{"id":4},{"id":5}]}]}]} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '973' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.16.0-develop + Keep-Alive: + - timeout=15, max=94 + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + 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: + - '0' + 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/environments?search=name%3D%22Prod%22&per_page=4294967296 + response: + body: + string: '{"total":5,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Prod\"","sort":{"by":"name","order":"asc"},"results":[{"library":false,"registry_name_pattern":null,"registry_unauthenticated_pull":false,"id":5,"name":"Prod","label":"prod","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:02 UTC","updated_at":"2025-07-11 15:22:02 UTC","prior":{"name":"QA","id":4},"successor":null,"counts":{"content_hosts":0,"content_views":1},"permissions":{"create_lifecycle_environments":true,"view_lifecycle_environments":true,"edit_lifecycle_environments":true,"destroy_lifecycle_environments":true,"promote_or_remove_content_views_to_environments":true},"content_views":[{"name":"Test + Content View","id":6}],"capsules":[{"id":1,"name":"foreman.example.com","lifecycle_environments":[{"id":1},{"id":2},{"id":3},{"id":4},{"id":5}]}]}]} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '959' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.16.0-develop + Keep-Alive: + - timeout=15, max=93 + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + 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: + - '0' + 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/environments?search=name%3D%22Test%22&per_page=4294967296 + response: + body: + string: '{"total":5,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Test\"","sort":{"by":"name","order":"asc"},"results":[{"library":false,"registry_name_pattern":null,"registry_unauthenticated_pull":false,"id":3,"name":"Test","label":"test","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:00 UTC","updated_at":"2025-07-11 15:22:00 UTC","prior":{"name":"Library","id":2},"successor":{"name":"QA","id":4},"counts":{"content_hosts":0,"content_views":1},"permissions":{"create_lifecycle_environments":true,"view_lifecycle_environments":true,"edit_lifecycle_environments":true,"destroy_lifecycle_environments":true,"promote_or_remove_content_views_to_environments":true},"content_views":[{"name":"Test + Content View","id":6}],"capsules":[{"id":1,"name":"foreman.example.com","lifecycle_environments":[{"id":1},{"id":2},{"id":3},{"id":4},{"id":5}]}]}]} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '980' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.16.0-develop + Keep-Alive: + - timeout=15, max=92 + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + 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: + - '0' + status: + code: 200 + message: OK version: 1 diff --git a/tests/test_playbooks/fixtures/content_view-22.yml b/tests/test_playbooks/fixtures/content_view-22.yml index 30bc4c579d..06dcf837ea 100644 --- a/tests/test_playbooks/fixtures/content_view-22.yml +++ b/tests/test_playbooks/fixtures/content_view-22.yml @@ -72,8 +72,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\":\"2025-06-05 - 07:17:51 UTC\",\"updated_at\":\"2025-06-05 07:17:54 UTC\",\"id\":3,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -131,14 +131,14 @@ 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,"rolling":true,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":4,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"repository_ids":[1],"id":6,"name":"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"rolling":true,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":4,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"environment_ids":[3,4,5],"repository_ids":[1],"id":6,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test - Organization","label":"Test_Organization","id":3},"created_at":"2025-06-05 - 07:18:55 UTC","updated_at":"2025-06-05 07:18:55 UTC","last_task":null,"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":4,"version":"1.0","published":"2025-06-05 - 07:18:55 UTC","description":null,"environment_ids":[2],"filters_applied":null,"published_at_words":"less - than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-06-05 - 07:18:55 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}]}]} + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:23:00 UTC","updated_at":"2025-07-11 15:23:00 UTC","last_task":null,"latest_version_environments":[{"id":3,"name":"Test","label":"test"},{"id":4,"name":"QA","label":"qa"},{"id":5,"name":"Prod","label":"prod"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":4,"version":"1.0","published":"2025-07-11 + 15:23:00 UTC","description":null,"environment_ids":[3,4,5],"filters_applied":null,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:23:00 UTC","environments":[{"id":3,"label":"test","name":"Test","activation_keys":[],"hosts":[],"permissions":{"readable":true}},{"id":4,"label":"qa","name":"QA","activation_keys":[],"hosts":[],"permissions":{"readable":true}},{"id":5,"label":"prod","name":"Prod","activation_keys":[],"hosts":[],"permissions":{"readable":true}}]}]} ' headers: @@ -147,7 +147,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1437' + - '1727' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -196,14 +196,14 @@ interactions: uri: https://foreman.example.org/katello/api/content_views/6 response: body: - string: ' {"content_host_count":0,"composite":false,"rolling":true,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":4,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"repository_ids":[1],"id":6,"name":"Test + string: ' {"content_host_count":0,"composite":false,"rolling":true,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":4,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"environment_ids":[3,4,5],"repository_ids":[1],"id":6,"name":"Test Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test - Organization","label":"Test_Organization","id":3},"created_at":"2025-06-05 - 07:18:55 UTC","updated_at":"2025-06-05 07:18:55 UTC","last_task":null,"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":4,"version":"1.0","published":"2025-06-05 - 07:18:55 UTC","description":null,"environment_ids":[2],"filters_applied":null,"published_at_words":"less - than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-06-05 - 07:18:55 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:23:00 UTC","updated_at":"2025-07-11 15:23:00 UTC","last_task":null,"latest_version_environments":[{"id":3,"name":"Test","label":"test"},{"id":4,"name":"QA","label":"qa"},{"id":5,"name":"Prod","label":"prod"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":4,"version":"1.0","published":"2025-07-11 + 15:23:00 UTC","description":null,"environment_ids":[3,4,5],"filters_applied":null,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:23:00 UTC","environments":[{"id":3,"label":"test","name":"Test","activation_keys":[],"hosts":[],"permissions":{"readable":true}},{"id":4,"label":"qa","name":"QA","activation_keys":[],"hosts":[],"permissions":{"readable":true}},{"id":5,"label":"prod","name":"Prod","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} ' headers: @@ -212,7 +212,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '1307' + - '1597' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -260,18 +260,18 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: DELETE - uri: https://foreman.example.org/katello/api/content_views/6/environments/2 + uri: https://foreman.example.org/katello/api/content_views/6/environments/3 response: body: - string: ' {"id":"e883e581-d1bd-42c7-86a0-bb0f85b8bfcb","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":true,"action":"Remove - from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-06-05 - 07:19:00 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":6,"name":"Test + string: ' {"id":"cd663cc0-a98a-49b1-a06f-7f89a8172788","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":true,"action":"Remove + from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:23:08 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":6,"name":"Test Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":3,"current_request_id":"61e6cdfd-6d7b-45ee-8732-3d98c4c0013d","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Remove + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":3,"current_request_id":"fd083ec9-effd-40ff-a04b-aaf016aa2999","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Remove from Environment","input":[["content_view",{"text":"content view ''Test Content View''","link":"/content_views/6/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-06-05 - 07:19:00 UTC","available_actions":{"cancellable":false,"resumable":false}} + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:23:08 UTC","available_actions":{"cancellable":false,"resumable":false}} ' headers: @@ -326,25 +326,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/foreman_tasks/api/tasks/e883e581-d1bd-42c7-86a0-bb0f85b8bfcb + uri: https://foreman.example.org/foreman_tasks/api/tasks/cd663cc0-a98a-49b1-a06f-7f89a8172788 response: body: - string: '{"id":"e883e581-d1bd-42c7-86a0-bb0f85b8bfcb","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":false,"action":"Remove - from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-06-05 - 07:19:00 UTC","ended_at":"2025-06-05 07:19:01 UTC","duration":"0.923435","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":6,"name":"Test + string: '{"id":"cd663cc0-a98a-49b1-a06f-7f89a8172788","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":false,"action":"Remove + from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:23:08 UTC","ended_at":"2025-07-11 15:23:09 UTC","duration":"1.07755","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":6,"name":"Test Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":3,"current_request_id":"61e6cdfd-6d7b-45ee-8732-3d98c4c0013d","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Remove + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":3,"current_request_id":"fd083ec9-effd-40ff-a04b-aaf016aa2999","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Remove from Environment","input":[["content_view",{"text":"content view ''Test Content View''","link":"/content_views/6/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-06-05 - 07:19:00 UTC","available_actions":{"cancellable":false,"resumable":false}}' + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:23:08 UTC","available_actions":{"cancellable":false,"resumable":false}}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive Content-Length: - - '1198' + - '1197' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -378,6 +378,270 @@ 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/6/environments/4 + response: + body: + string: ' {"id":"a78d67b4-9508-414d-ab97-4c5821119778","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":true,"action":"Remove + from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:23:13 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":6,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":4,"current_request_id":"ce706199-9fe6-433e-ae77-d2a7400e2c9e","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Remove + from Environment","input":[["content_view",{"text":"content view ''Test Content + View''","link":"/content_views/6/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:23:13 UTC","available_actions":{"cancellable":false,"resumable":false}} + + ' + headers: + Cache-Control: + - no-cache + Connection: + - Keep-Alive + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.16.0-develop + Keep-Alive: + - timeout=15, max=94 + Referrer-Policy: + - strict-origin-when-cross-origin + Transfer-Encoding: + - chunked + content-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''' + 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: + - '0' + status: + code: 202 + message: Accepted +- 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/foreman_tasks/api/tasks/a78d67b4-9508-414d-ab97-4c5821119778 + response: + body: + string: '{"id":"a78d67b4-9508-414d-ab97-4c5821119778","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":false,"action":"Remove + from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:23:13 UTC","ended_at":"2025-07-11 15:23:14 UTC","duration":"1.040576","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":6,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":4,"current_request_id":"ce706199-9fe6-433e-ae77-d2a7400e2c9e","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Remove + from Environment","input":[["content_view",{"text":"content view ''Test Content + View''","link":"/content_views/6/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:23:13 UTC","available_actions":{"cancellable":false,"resumable":false}}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '1198' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.16.0-develop + Keep-Alive: + - timeout=15, max=93 + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + 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: + - '0' + 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/6/environments/5 + response: + body: + string: ' {"id":"9785559f-88d1-41ce-9ee8-1cb051c4c9eb","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":true,"action":"Remove + from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:23:18 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":6,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":5,"current_request_id":"c1133ee7-8d6f-4cda-8c2d-e2944428fba9","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Remove + from Environment","input":[["content_view",{"text":"content view ''Test Content + View''","link":"/content_views/6/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:23:17 UTC","available_actions":{"cancellable":false,"resumable":false}} + + ' + headers: + Cache-Control: + - no-cache + Connection: + - Keep-Alive + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.16.0-develop + Keep-Alive: + - timeout=15, max=92 + Referrer-Policy: + - strict-origin-when-cross-origin + Transfer-Encoding: + - chunked + content-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''' + 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: + - '0' + status: + code: 202 + message: Accepted +- 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/foreman_tasks/api/tasks/9785559f-88d1-41ce-9ee8-1cb051c4c9eb + response: + body: + string: '{"id":"9785559f-88d1-41ce-9ee8-1cb051c4c9eb","label":"Actions::Katello::ContentView::RemoveFromEnvironment","pending":false,"action":"Remove + from Environment content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:23:18 UTC","ended_at":"2025-07-11 15:23:18 UTC","duration":"0.831891","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":6,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":5,"current_request_id":"c1133ee7-8d6f-4cda-8c2d-e2944428fba9","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Remove + from Environment","input":[["content_view",{"text":"content view ''Test Content + View''","link":"/content_views/6/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:23:17 UTC","available_actions":{"cancellable":false,"resumable":false}}' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Length: + - '1198' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 3.16.0-develop + Keep-Alive: + - timeout=15, max=91 + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + 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: + - '0' + status: + code: 200 + message: OK - request: body: null headers: @@ -395,14 +659,14 @@ interactions: uri: https://foreman.example.org/katello/api/content_views/6 response: body: - string: ' {"id":"0787b01d-e1cf-4fec-8f62-75e14ff722b4","label":"Actions::Katello::ContentView::Destroy","pending":true,"action":"Delete - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-06-05 - 07:19:05 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":6,"name":"Test + string: ' {"id":"678add80-e64e-4789-a873-7437dfce828a","label":"Actions::Katello::ContentView::Destroy","pending":true,"action":"Delete + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:23:22 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":6,"name":"Test Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":"caa112ba-c1d9-4b7e-84b5-a0c3676735a0","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content + Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":"ddf00b30-762a-4b07-95a2-431b930079bd","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content view ''Test Content View''","link":"/content_views/6/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-06-05 - 07:19:05 UTC","available_actions":{"cancellable":false,"resumable":false}} + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:23:22 UTC","available_actions":{"cancellable":false,"resumable":false}} ' headers: @@ -421,7 +685,7 @@ interactions: Foreman_version: - 3.16.0-develop Keep-Alive: - - timeout=15, max=94 + - timeout=15, max=90 Referrer-Policy: - strict-origin-when-cross-origin Transfer-Encoding: @@ -457,17 +721,17 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/foreman_tasks/api/tasks/0787b01d-e1cf-4fec-8f62-75e14ff722b4 + uri: https://foreman.example.org/foreman_tasks/api/tasks/678add80-e64e-4789-a873-7437dfce828a response: body: - string: '{"id":"0787b01d-e1cf-4fec-8f62-75e14ff722b4","label":"Actions::Katello::ContentView::Destroy","pending":false,"action":"Delete - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-06-05 - 07:19:05 UTC","ended_at":"2025-06-05 07:19:05 UTC","duration":"0.421077","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":6,"name":"Test + string: '{"id":"678add80-e64e-4789-a873-7437dfce828a","label":"Actions::Katello::ContentView::Destroy","pending":false,"action":"Delete + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:23:22 UTC","ended_at":"2025-07-11 15:23:22 UTC","duration":"0.375412","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":6,"name":"Test Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":"caa112ba-c1d9-4b7e-84b5-a0c3676735a0","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content + Organization","label":"Test_Organization"},"services_checked":["pulp3"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":"ddf00b30-762a-4b07-95a2-431b930079bd","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Delete","input":[["content_view",{"text":"content view ''Test Content View''","link":"/content_views/6/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-06-05 - 07:19:05 UTC","available_actions":{"cancellable":false,"resumable":false}}' + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:23:22 UTC","available_actions":{"cancellable":false,"resumable":false}}' headers: Cache-Control: - max-age=0, private, must-revalidate @@ -486,7 +750,7 @@ interactions: Foreman_version: - 3.16.0-develop Keep-Alive: - - timeout=15, max=93 + - timeout=15, max=89 Referrer-Policy: - strict-origin-when-cross-origin content-security-policy: diff --git a/tests/test_playbooks/fixtures/content_view-23.yml b/tests/test_playbooks/fixtures/content_view-23.yml index 9068d557e4..cde7a92f82 100644 --- a/tests/test_playbooks/fixtures/content_view-23.yml +++ b/tests/test_playbooks/fixtures/content_view-23.yml @@ -72,8 +72,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\":\"2025-06-05 - 07:17:51 UTC\",\"updated_at\":\"2025-06-05 07:17:54 UTC\",\"id\":3,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: diff --git a/tests/test_playbooks/fixtures/content_view-3.yml b/tests/test_playbooks/fixtures/content_view-3.yml index 47cfe4cefc..cde7a92f82 100644 --- a/tests/test_playbooks/fixtures/content_view-3.yml +++ b/tests/test_playbooks/fixtures/content_view-3.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,10 +127,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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,10 +139,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-Length: + - '170' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -151,27 +148,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '157' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-4.yml b/tests/test_playbooks/fixtures/content_view-4.yml index 35b6f55756..7c74caf103 100644 --- a/tests/test_playbooks/fixtures/content_view-4.yml +++ b/tests/test_playbooks/fixtures/content_view-4.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,10 +127,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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,10 +139,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-Length: + - '170' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -151,27 +148,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '157' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -187,14 +186,13 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/products?search=name%3D%22Test+Product%22&per_page=4294967296 response: body: - string: '{"total":2,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":18,"cp_id":"956117903760","name":"Test - Product","label":"Test_Product","description":"A happy little test product","provider_id":25,"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":"2020-09-14 - 10:19:27 UTC","last_sync_words":"less than a minute","organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"sync_plan":null,"repository_count":1}]} + string: '{"total":2,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":1,"cp_id":"624377688211","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":3,"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":null,"last_sync_words":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":1}]} ' headers: @@ -202,10 +200,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-Length: + - '625' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -213,27 +209,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '653' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -249,15 +247,16 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/18/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/1/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":"1819fd9f-8231-43ee-9132-a87a073ba3d7","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"http://centos7-katello-3-16.yatsu.example.com/pulp/repos/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"id":30,"name":"Test - Repository","label":"Test_Repository","description":null,"last_sync":null,"content_view":{"id":29,"name":"Default - Organization View"},"content_view_version":{"id":18,"name":"Default Organization - View 1.0","content_view_id":29},"kt_environment":{"id":13,"name":"Library"},"content_type":"yum","url":null,"arch":"noarch","content_id":"1600078766677","major":null,"minor":null,"product":{"id":18,"cp_id":"956117903760","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":"f5cc71fb-3e1f-48d2-8db4-68349096758f","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,"full_gpg_key_path":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/0197fa14-1de9-7a8c-ac85-fff97edefbdd/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/0197fa14-239a-7acb-a6b3-ba44220d968c/","content_counts":{"rpm":0,"erratum":0,"package_group":0,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":1,"name":"Test + Repository","label":"Test_Repository","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"content_view_versions":[],"filters":[],"last_sync":null,"content_view":{"id":2,"name":"Default + Organization View"},"content_view_version":{"id":2,"name":"Default Organization + View 1.0","content_view_id":2},"kt_environment":{"id":2,"name":"Library"},"content_type":"yum","url":null,"docker_upstream_name":null,"arch":"noarch","os_versions":[],"content_id":"1752247312252","generic_remote_options":null,"major":null,"minor":null,"product":{"id":1,"cp_id":"624377688211","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":2} ' headers: @@ -265,10 +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-Length: + - '1679' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -278,30 +275,32 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1319' + x-xss-protection: + - '0' status: code: 200 message: OK - request: - body: '{"name": "Test Content View", "composite": false, "repository_ids": [30], + body: '{"name": "Test Content View", "composite": false, "repository_ids": [1], "auto_publish": false}' headers: Accept: @@ -311,20 +310,20 @@ interactions: Connection: - keep-alive Content-Length: - - '96' + - '95' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/organizations/14/content_views + uri: https://foreman.example.org/katello/api/organizations/3/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,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:43 UTC","environments":[],"repositories":[{"id":30,"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":[]} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:18 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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":[],"errors":null} ' headers: @@ -332,10 +331,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-Length: + - '991' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -343,25 +340,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Transfer-Encoding: - - chunked - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 201 message: Created diff --git a/tests/test_playbooks/fixtures/content_view-5.yml b/tests/test_playbooks/fixtures/content_view-5.yml index 66239b6ba3..07e6d5f6c6 100644 --- a/tests/test_playbooks/fixtures/content_view-5.yml +++ b/tests/test_playbooks/fixtures/content_view-5.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,15 +127,15 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 response: body: - string: '{"total":2,"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,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:43 UTC","environments":[],"repositories":[{"id":30,"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":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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:18 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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,10 +143,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-Length: + - '1121' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -155,27 +152,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1040' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -191,10 +190,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_view_versions?search=content_view_id%3D31%2Cversion%3D1.0&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_view_versions?search=content_view_id%3D4%2Cversion%3D1.0&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"content_view_id=31,version=1.0","sort":{"by":"version","order":"desc"},"results":[]} + string: '{"total":2,"subtotal":0,"selectable":0,"page":1,"per_page":4294967296,"error":null,"search":"content_view_id=4,version=1.0","sort":{"by":"version","order":"desc"},"results":[]} ' headers: @@ -202,10 +201,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-Length: + - '177' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -215,25 +212,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '165' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -249,12 +248,12 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/environments?search=name%3D%22Library%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/environments?search=name%3D%22Library%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Library\"","sort":{"by":"name","order":"asc"},"results":[{"library":true,"registry_name_pattern":null,"registry_unauthenticated_pull":false,"id":13,"name":"Library","label":"Library","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:22 UTC","updated_at":"2020-09-14 10:19:22 UTC","prior":null,"successor":null,"counts":{"content_hosts":0,"content_views":0,"packages":0,"puppet_modules":0,"module_streams":0,"errata":{"security":null,"bugfix":0,"enhancement":0,"total":null},"yum_repositories":2,"docker_repositories":0,"ostree_repositories":0,"products":2},"permissions":{"create_lifecycle_environments":true,"view_lifecycle_environments":true,"edit_lifecycle_environments":true,"destroy_lifecycle_environments":false,"promote_or_remove_content_views_to_environments":true}}]} + string: '{"total":4,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"name=\"Library\"","sort":{"by":"name","order":"asc"},"results":[{"library":true,"registry_name_pattern":null,"registry_unauthenticated_pull":false,"id":2,"name":"Library","label":"Library","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:21:43 UTC","updated_at":"2025-07-11 15:21:43 UTC","prior":null,"successor":null,"counts":{"content_hosts":0,"content_views":0,"packages":0,"module_streams":0,"errata":{"security":0,"bugfix":0,"enhancement":0,"total":0},"yum_repositories":2,"docker_repositories":0,"ostree_repositories":0,"products":2,"debs":0,"deb_repositories":0},"permissions":{"create_lifecycle_environments":true,"view_lifecycle_environments":true,"edit_lifecycle_environments":true,"destroy_lifecycle_environments":false,"promote_or_remove_content_views_to_environments":true},"content_views":[],"capsules":[{"id":1,"name":"foreman.example.com","lifecycle_environments":[{"id":1},{"id":2},{"id":3},{"id":4},{"id":5}]}]}]} ' headers: @@ -262,10 +261,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-Length: + - '1122' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -273,27 +270,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '965' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -313,18 +312,18 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/content_views/31/publish + uri: https://foreman.example.org/katello/api/content_views/4/publish response: body: - string: ' {"id":"dce95aeb-7d0d-49d1-829f-8c263c4bbc47","label":"Actions::Katello::ContentView::Publish","pending":true,"action":"Publish - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:19:44 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["candlepin","candlepin_auth","pulp3","pulp","pulp_auth"],"history_id":24,"content_view_id":31,"auto_publish_composite_ids":[],"content_view_version_name":"Test - Content View 1.0","content_view_version_id":19,"environment_id":13,"user_id":4,"skip_promotion":null,"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{},"humanized":{"action":"Publish","input":[["content_view",{"text":"content - view ''Test Content View''","link":"/content_views/31/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:19:44 UTC","available_actions":{"cancellable":false,"resumable":false}} + string: ' {"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","label":"Actions::Katello::ContentView::Publish","pending":true,"action":"Publish + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:19 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":1,"content_view_id":4,"auto_publish_composite_ids":[],"content_view_version_name":"Test + Content View 1.0","content_view_version_id":3,"environment_id":2,"user_id":4,"skip_promotion":null,"current_request_id":"5d8b36e2-b73a-497e-a358-9fc98cabdad2","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Publish","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/4/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:19 UTC","available_actions":{"cancellable":false,"resumable":false}} ' headers: @@ -332,10 +331,6 @@ interactions: - no-cache 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: @@ -345,23 +340,29 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: - - max-age=631139040; includeSubdomains + Referrer-Policy: + - strict-origin-when-cross-origin Transfer-Encoding: - chunked - X-Content-Type-Options: + content-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''' + strict-transport-security: + - max-age=631139040; includeSubdomains + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 202 message: Accepted @@ -377,27 +378,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/foreman_tasks/api/tasks/dce95aeb-7d0d-49d1-829f-8c263c4bbc47 + uri: https://foreman.example.org/foreman_tasks/api/tasks/6f661932-5bdd-4f8f-a521-f5875e5339f4 response: body: - string: '{"id":"dce95aeb-7d0d-49d1-829f-8c263c4bbc47","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:19:44 UTC","ended_at":"2020-09-14 10:19:47 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["candlepin","candlepin_auth","pulp3","pulp","pulp_auth"],"history_id":24,"content_view_id":31,"auto_publish_composite_ids":[],"content_view_version_name":"Test - Content View 1.0","content_view_version_id":19,"environment_id":13,"user_id":4,"skip_promotion":null,"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{"content_view_id":31,"content_view_version_id":19,"skip_promotion":null},"humanized":{"action":"Publish","input":[["content_view",{"text":"content - view ''Test Content View''","link":"/content_views/31/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:19:44 UTC","available_actions":{"cancellable":false,"resumable":false}}' + string: '{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:19 UTC","ended_at":"2025-07-11 15:22:23 UTC","duration":"3.865006","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":1,"content_view_id":4,"auto_publish_composite_ids":[],"content_view_version_name":"Test + Content View 1.0","content_view_version_id":3,"environment_id":2,"user_id":4,"skip_promotion":null,"current_request_id":"5d8b36e2-b73a-497e-a358-9fc98cabdad2","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{"content_view_id":4,"content_view_version_id":3,"skip_promotion":null,"history_id":1},"humanized":{"action":"Publish","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/4/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:19 UTC","available_actions":{"cancellable":false,"resumable":false}}' headers: Cache-Control: - 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-Length: + - '1421' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -407,25 +406,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=94 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1379' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -441,22 +442,23 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_view_versions/19 + uri: https://foreman.example.org/katello/api/content_view_versions/3 response: body: - string: ' {"version":"1.0","major":1,"minor":0,"composite_content_view_ids":[],"published_in_composite_content_view_ids":[],"content_view_id":31,"default":false,"description":null,"id":19,"name":"Test - Content View 1.0","created_at":"2020-09-14 10:19:44 UTC","updated_at":"2020-09-14 - 10:19:47 UTC","content_view":{"id":31,"name":"Test Content View","label":"Test_Content_View"},"composite_content_views":[],"composite_content_view_versions":[],"published_in_composite_content_views":[],"environments":[{"id":13,"name":"Library","label":"Library","puppet_environment_id":null,"permissions":{"readable":true,"promotable_or_removable":true,"all_hosts_editable":true,"all_keys_editable":true},"host_count":0,"activation_key_count":0}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","library_instance_id":30}],"last_event":{"user":"admin","status":"successful","description":null,"action":"publish","created_at":"2020-09-14 - 10:19:44 UTC","updated_at":"2020-09-14 10:19:47 UTC","environment":null,"task":{"id":"dce95aeb-7d0d-49d1-829f-8c263c4bbc47","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:19:44 UTC","ended_at":"2020-09-14 10:19:47 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["candlepin","candlepin_auth","pulp3","pulp","pulp_auth"],"history_id":24,"content_view_id":31,"auto_publish_composite_ids":[],"content_view_version_name":"Test - Content View 1.0","content_view_version_id":19,"environment_id":13,"user_id":4,"skip_promotion":null,"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{"content_view_id":31,"content_view_version_id":19,"skip_promotion":null},"humanized":{"action":"Publish","input":[["content_view",{"text":"content - view ''Test Content View''","link":"/content_views/31/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:19:44 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":true,"version_id":19,"triggered_by":null,"triggered_by_id":null},"active_history":[],"deb_count":0,"docker_manifest_count":0,"docker_manifest_list_count":0,"docker_tag_count":0,"file_count":0,"puppet_module_count":0,"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"module_stream_count":0,"package_count":0,"ostree_branch_count":null,"errata_counts":{"security":null,"bugfix":0,"enhancement":0,"total":null},"permissions":{"deletable":true},"puppet_modules":[]} + string: ' {"version":"1.0","major":1,"minor":0,"composite_content_view_ids":[],"published_in_composite_content_view_ids":[],"content_view_id":4,"default":false,"description":null,"id":3,"name":"Test + Content View 1.0","created_at":"2025-07-11 15:22:20 UTC","updated_at":"2025-07-11 + 15:22:23 UTC","content_view":{"id":4,"name":"Test Content View","label":"Test_Content_View","generated_for":"none"},"composite_content_views":[],"composite_content_view_versions":[],"published_in_composite_content_views":[],"content_view_environments":[{"label":"Library/Test_Content_View","environment_id":2,"environment_name":"Library"}],"environments":[{"id":2,"name":"Library","label":"Library","publish_date":"less + than a minute","permissions":{"readable":true,"promotable_or_removable":true,"all_hosts_editable":true,"all_keys_editable":true},"host_count":0,"multi_env_host_count":0,"activation_key_count":0,"multi_env_ak_count":0}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","library_instance_id":1,"mirroring_policy":"mirror_content_only"}],"last_event":{"user":"admin","status":"successful","description":null,"action":"publish","created_at":"2025-07-11 + 15:22:20 UTC","updated_at":"2025-07-11 15:22:23 UTC","environment":null,"task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:19 UTC","ended_at":"2025-07-11 15:22:23 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":1,"content_view_id":4,"auto_publish_composite_ids":[],"content_view_version_name":"Test + Content View 1.0","content_view_version_id":3,"environment_id":2,"user_id":4,"skip_promotion":null,"current_request_id":"5d8b36e2-b73a-497e-a358-9fc98cabdad2","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{"content_view_id":4,"content_view_version_id":3,"skip_promotion":null,"history_id":1},"humanized":{"action":"Publish","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/4/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:19 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":true,"version_id":3,"triggered_by":null,"triggered_by_id":null},"active_history":[],"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"ansible_collection_count":0,"deb_count":0,"docker_manifest_count":0,"docker_manifest_list_count":0,"docker_tag_count":0,"file_count":0,"python_package_count":0,"module_stream_count":0,"package_count":0,"component_view_count":0,"ansible_collection_repository_count":0,"deb_repository_count":0,"docker_repository_count":0,"file_repository_count":0,"python_repository_count":0,"yum_repository_count":1,"errata_counts":{"security":0,"bugfix":0,"enhancement":0,"total":0},"permissions":{"deletable":true},"filters_applied":false} ' headers: @@ -464,10 +466,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-Length: + - '3394' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -477,25 +477,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=93 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2948' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-6.yml b/tests/test_playbooks/fixtures/content_view-6.yml index ea3031f57c..6d77b98860 100644 --- a/tests/test_playbooks/fixtures/content_view-6.yml +++ b/tests/test_playbooks/fixtures/content_view-6.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,10 +127,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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,10 +139,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-Length: + - '180' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -151,27 +148,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '167' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -192,13 +191,13 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/organizations/14/content_views + uri: https://foreman.example.org/katello/api/organizations/3/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,"repository_ids":[],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:26 UTC","last_task":null,"latest_version_environments":[],"repositories":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -206,10 +205,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-Length: + - '929' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -217,25 +214,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Transfer-Encoding: - - chunked - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 201 message: Created @@ -251,17 +252,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}]}]} ' headers: @@ -269,10 +272,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-Length: + - '1599' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -280,27 +281,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1224' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -316,16 +319,18 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/31 + uri: https://foreman.example.org/katello/api/content_views/4 response: body: - string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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":[]} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":0,"related_composite_cvs":[],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} ' headers: @@ -333,10 +338,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-Length: + - '1469' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -346,25 +349,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1132' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -380,22 +385,23 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_view_versions?search=content_view_id%3D31%2Cversion%3D1.0&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_view_versions?search=content_view_id%3D4%2Cversion%3D1.0&per_page=4294967296 response: body: - string: '{"total":4,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"content_view_id=31,version=1.0","sort":{"by":"version","order":"desc"},"results":[{"version":"1.0","major":1,"minor":0,"composite_content_view_ids":[],"published_in_composite_content_view_ids":[],"content_view_id":31,"default":false,"description":null,"id":19,"name":"Test - Content View 1.0","created_at":"2020-09-14 10:19:44 UTC","updated_at":"2020-09-14 - 10:19:47 UTC","content_view":{"id":31,"name":"Test Content View","label":"Test_Content_View"},"composite_content_views":[],"composite_content_view_versions":[],"published_in_composite_content_views":[],"environments":[{"id":13,"name":"Library","label":"Library","puppet_environment_id":null,"permissions":{"readable":true,"promotable_or_removable":true,"all_hosts_editable":true,"all_keys_editable":true},"host_count":0,"activation_key_count":0}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","library_instance_id":30}],"last_event":{"user":"admin","status":"successful","description":null,"action":"publish","created_at":"2020-09-14 - 10:19:44 UTC","updated_at":"2020-09-14 10:19:47 UTC","environment":null,"task":{"id":"dce95aeb-7d0d-49d1-829f-8c263c4bbc47","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:19:44 UTC","ended_at":"2020-09-14 10:19:47 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["candlepin","candlepin_auth","pulp3","pulp","pulp_auth"],"history_id":24,"content_view_id":31,"auto_publish_composite_ids":[],"content_view_version_name":"Test - Content View 1.0","content_view_version_id":19,"environment_id":13,"user_id":4,"skip_promotion":null,"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{"content_view_id":31,"content_view_version_id":19,"skip_promotion":null},"humanized":{"action":"Publish","input":[["content_view",{"text":"content - view ''Test Content View''","link":"/content_views/31/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:19:44 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":true,"version_id":19,"triggered_by":null,"triggered_by_id":null},"active_history":[],"deb_count":0,"docker_manifest_count":0,"docker_manifest_list_count":0,"docker_tag_count":0,"file_count":0,"puppet_module_count":0,"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"module_stream_count":0,"package_count":0,"ostree_branch_count":null,"errata_counts":{"security":null,"bugfix":0,"enhancement":0,"total":null},"permissions":{"deletable":true}}]} + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"content_view_id=4,version=1.0","sort":{"by":"version","order":"desc"},"results":[{"version":"1.0","major":1,"minor":0,"composite_content_view_ids":[],"published_in_composite_content_view_ids":[],"content_view_id":4,"default":false,"description":null,"id":3,"name":"Test + Content View 1.0","created_at":"2025-07-11 15:22:20 UTC","updated_at":"2025-07-11 + 15:22:23 UTC","content_view":{"id":4,"name":"Test Content View","label":"Test_Content_View","generated_for":"none"},"composite_content_views":[],"composite_content_view_versions":[],"published_in_composite_content_views":[],"content_view_environments":[{"label":"Library/Test_Content_View","environment_id":2,"environment_name":"Library"}],"environments":[{"id":2,"name":"Library","label":"Library","publish_date":"less + than a minute","permissions":{"readable":true,"promotable_or_removable":true,"all_hosts_editable":true,"all_keys_editable":true},"host_count":0,"multi_env_host_count":0,"activation_key_count":0,"multi_env_ak_count":0}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","library_instance_id":1,"mirroring_policy":"mirror_content_only"}],"last_event":{"user":"admin","status":"successful","description":null,"action":"publish","created_at":"2025-07-11 + 15:22:20 UTC","updated_at":"2025-07-11 15:22:23 UTC","environment":null,"task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:19 UTC","ended_at":"2025-07-11 15:22:23 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":1,"content_view_id":4,"auto_publish_composite_ids":[],"content_view_version_name":"Test + Content View 1.0","content_view_version_id":3,"environment_id":2,"user_id":4,"skip_promotion":null,"current_request_id":"5d8b36e2-b73a-497e-a358-9fc98cabdad2","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{"content_view_id":4,"content_view_version_id":3,"skip_promotion":null,"history_id":1},"humanized":{"action":"Publish","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/4/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:19 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":true,"version_id":3,"triggered_by":null,"triggered_by_id":null},"active_history":[],"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"ansible_collection_count":0,"deb_count":0,"docker_manifest_count":0,"docker_manifest_list_count":0,"docker_tag_count":0,"file_count":0,"python_package_count":0,"module_stream_count":0,"package_count":0,"component_view_count":0,"ansible_collection_repository_count":0,"deb_repository_count":0,"docker_repository_count":0,"file_repository_count":0,"python_repository_count":0,"yum_repository_count":1,"errata_counts":{"security":0,"bugfix":0,"enhancement":0,"total":0},"permissions":{"deletable":true},"filters_applied":false}]} ' headers: @@ -403,10 +409,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-Length: + - '3568' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -416,31 +420,33 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=94 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '3090' + x-xss-protection: + - '0' status: code: 200 message: OK - request: - body: '{"components": [{"latest": false, "content_view_id": 31, "content_view_version_id": - 19}]}' + body: '{"components": [{"latest": false, "content_view_id": 4, "content_view_version_id": + 3}]}' headers: Accept: - application/json;version=2 @@ -449,22 +455,23 @@ interactions: Connection: - keep-alive Content-Length: - - '89' + - '87' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: PUT - uri: https://foreman.example.org/katello/api/content_views/32/content_view_components/add + uri: https://foreman.example.org/katello/api/content_views/5/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":false,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}]} + string: '{"total":1,"subtotal":1,"selectable":1,"page":null,"per_page":null,"error":null,"search":null,"sort":{"by":null,"order":null},"results":[{"latest":false,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:27 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}]} ' headers: @@ -472,10 +479,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-Length: + - '1058' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -485,25 +490,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=93 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '928' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-7.yml b/tests/test_playbooks/fixtures/content_view-7.yml index 106ec1975b..37be0cbbab 100644 --- a/tests/test_playbooks/fixtures/content_view-7.yml +++ b/tests/test_playbooks/fixtures/content_view-7.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,24 +127,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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 + Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"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":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:26 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:27 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -153,10 +153,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-Length: + - '2439' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -164,27 +162,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2249' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -200,23 +200,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 response: body: - string: ' {"content_host_count":0,"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"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":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:26 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:27 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -224,10 +225,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-Length: + - '2299' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -237,25 +236,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2147' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -271,17 +272,20 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[{"id":5,"name":"Test + Composite Content View"}],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}]}]} ' headers: @@ -289,10 +293,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-Length: + - '1644' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -300,27 +302,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1224' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -336,16 +340,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/31 + uri: https://foreman.example.org/katello/api/content_views/4 response: body: - string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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":[]} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[{"id":5,"name":"Test + Composite Content View"}],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} ' headers: @@ -353,10 +360,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-Length: + - '1514' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -366,25 +371,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1132' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -400,23 +407,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_view_versions?search=content_view_id%3D31%2Cversion%3D1.0&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_view_versions?search=content_view_id%3D4%2Cversion%3D1.0&per_page=4294967296 response: body: - string: '{"total":4,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"content_view_id=31,version=1.0","sort":{"by":"version","order":"desc"},"results":[{"version":"1.0","major":1,"minor":0,"composite_content_view_ids":[32],"published_in_composite_content_view_ids":[],"content_view_id":31,"default":false,"description":null,"id":19,"name":"Test - Content View 1.0","created_at":"2020-09-14 10:19:44 UTC","updated_at":"2020-09-14 - 10:19:47 UTC","content_view":{"id":31,"name":"Test Content View","label":"Test_Content_View"},"composite_content_views":[{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View"}],"composite_content_view_versions":[],"published_in_composite_content_views":[],"environments":[{"id":13,"name":"Library","label":"Library","puppet_environment_id":null,"permissions":{"readable":true,"promotable_or_removable":true,"all_hosts_editable":true,"all_keys_editable":true},"host_count":0,"activation_key_count":0}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","library_instance_id":30}],"last_event":{"user":"admin","status":"successful","description":null,"action":"publish","created_at":"2020-09-14 - 10:19:44 UTC","updated_at":"2020-09-14 10:19:47 UTC","environment":null,"task":{"id":"dce95aeb-7d0d-49d1-829f-8c263c4bbc47","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:19:44 UTC","ended_at":"2020-09-14 10:19:47 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["candlepin","candlepin_auth","pulp3","pulp","pulp_auth"],"history_id":24,"content_view_id":31,"auto_publish_composite_ids":[],"content_view_version_name":"Test - Content View 1.0","content_view_version_id":19,"environment_id":13,"user_id":4,"skip_promotion":null,"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{"content_view_id":31,"content_view_version_id":19,"skip_promotion":null},"humanized":{"action":"Publish","input":[["content_view",{"text":"content - view ''Test Content View''","link":"/content_views/31/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:19:44 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":true,"version_id":19,"triggered_by":null,"triggered_by_id":null},"active_history":[],"deb_count":0,"docker_manifest_count":0,"docker_manifest_list_count":0,"docker_tag_count":0,"file_count":0,"puppet_module_count":0,"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"module_stream_count":0,"package_count":0,"ostree_branch_count":null,"errata_counts":{"security":null,"bugfix":0,"enhancement":0,"total":null},"permissions":{"deletable":true}}]} + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"content_view_id=4,version=1.0","sort":{"by":"version","order":"desc"},"results":[{"version":"1.0","major":1,"minor":0,"composite_content_view_ids":[5],"published_in_composite_content_view_ids":[],"content_view_id":4,"default":false,"description":null,"id":3,"name":"Test + Content View 1.0","created_at":"2025-07-11 15:22:20 UTC","updated_at":"2025-07-11 + 15:22:23 UTC","content_view":{"id":4,"name":"Test Content View","label":"Test_Content_View","generated_for":"none"},"composite_content_views":[{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View"}],"composite_content_view_versions":[],"published_in_composite_content_views":[],"content_view_environments":[{"label":"Library/Test_Content_View","environment_id":2,"environment_name":"Library"}],"environments":[{"id":2,"name":"Library","label":"Library","publish_date":"less + than a minute","permissions":{"readable":true,"promotable_or_removable":true,"all_hosts_editable":true,"all_keys_editable":true},"host_count":0,"multi_env_host_count":0,"activation_key_count":0,"multi_env_ak_count":0}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","library_instance_id":1,"mirroring_policy":"mirror_content_only"}],"last_event":{"user":"admin","status":"successful","description":null,"action":"publish","created_at":"2025-07-11 + 15:22:20 UTC","updated_at":"2025-07-11 15:22:23 UTC","environment":null,"task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:19 UTC","ended_at":"2025-07-11 15:22:23 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":1,"content_view_id":4,"auto_publish_composite_ids":[],"content_view_version_name":"Test + Content View 1.0","content_view_version_id":3,"environment_id":2,"user_id":4,"skip_promotion":null,"current_request_id":"5d8b36e2-b73a-497e-a358-9fc98cabdad2","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{"content_view_id":4,"content_view_version_id":3,"skip_promotion":null,"history_id":1},"humanized":{"action":"Publish","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/4/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:19 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":true,"version_id":3,"triggered_by":null,"triggered_by_id":null},"active_history":[],"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"ansible_collection_count":0,"deb_count":0,"docker_manifest_count":0,"docker_manifest_list_count":0,"docker_tag_count":0,"file_count":0,"python_package_count":0,"module_stream_count":0,"package_count":0,"component_view_count":0,"ansible_collection_repository_count":0,"deb_repository_count":0,"docker_repository_count":0,"file_repository_count":0,"python_repository_count":0,"yum_repository_count":1,"errata_counts":{"security":0,"bugfix":0,"enhancement":0,"total":0},"permissions":{"deletable":true},"filters_applied":false}]} ' headers: @@ -424,10 +432,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-Length: + - '3652' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -437,25 +443,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=94 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '3176' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-8.yml b/tests/test_playbooks/fixtures/content_view-8.yml index 84bca9ba57..cfe9e611a0 100644 --- a/tests/test_playbooks/fixtures/content_view-8.yml +++ b/tests/test_playbooks/fixtures/content_view-8.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,24 +127,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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 + Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"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":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:26 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:27 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -153,10 +153,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-Length: + - '2439' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -164,27 +162,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2249' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -200,23 +200,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 response: body: - string: ' {"content_host_count":0,"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"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":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:26 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:27 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -224,10 +225,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-Length: + - '2299' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -237,25 +236,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2147' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -275,23 +276,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: PUT - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 response: body: - string: ' {"content_host_count":0,"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:27 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -299,10 +301,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-Length: + - '2298' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -312,25 +312,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2146' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -346,17 +348,20 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[{"id":5,"name":"Test + Composite Content View"}],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}]}]} ' headers: @@ -364,10 +369,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-Length: + - '1644' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -375,27 +378,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1224' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -411,16 +416,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/31 + uri: https://foreman.example.org/katello/api/content_views/4 response: body: - string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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":[]} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[{"id":5,"name":"Test + Composite Content View"}],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} ' headers: @@ -428,10 +436,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-Length: + - '1514' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -441,25 +447,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=94 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1132' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -475,23 +483,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_view_versions?search=content_view_id%3D31%2Cversion%3D1.0&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_view_versions?search=content_view_id%3D4%2Cversion%3D1.0&per_page=4294967296 response: body: - string: '{"total":4,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"content_view_id=31,version=1.0","sort":{"by":"version","order":"desc"},"results":[{"version":"1.0","major":1,"minor":0,"composite_content_view_ids":[32],"published_in_composite_content_view_ids":[],"content_view_id":31,"default":false,"description":null,"id":19,"name":"Test - Content View 1.0","created_at":"2020-09-14 10:19:44 UTC","updated_at":"2020-09-14 - 10:19:47 UTC","content_view":{"id":31,"name":"Test Content View","label":"Test_Content_View"},"composite_content_views":[{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View"}],"composite_content_view_versions":[],"published_in_composite_content_views":[],"environments":[{"id":13,"name":"Library","label":"Library","puppet_environment_id":null,"permissions":{"readable":true,"promotable_or_removable":true,"all_hosts_editable":true,"all_keys_editable":true},"host_count":0,"activation_key_count":0}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","library_instance_id":30}],"last_event":{"user":"admin","status":"successful","description":null,"action":"publish","created_at":"2020-09-14 - 10:19:44 UTC","updated_at":"2020-09-14 10:19:47 UTC","environment":null,"task":{"id":"dce95aeb-7d0d-49d1-829f-8c263c4bbc47","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:19:44 UTC","ended_at":"2020-09-14 10:19:47 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["candlepin","candlepin_auth","pulp3","pulp","pulp_auth"],"history_id":24,"content_view_id":31,"auto_publish_composite_ids":[],"content_view_version_name":"Test - Content View 1.0","content_view_version_id":19,"environment_id":13,"user_id":4,"skip_promotion":null,"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{"content_view_id":31,"content_view_version_id":19,"skip_promotion":null},"humanized":{"action":"Publish","input":[["content_view",{"text":"content - view ''Test Content View''","link":"/content_views/31/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:19:44 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":true,"version_id":19,"triggered_by":null,"triggered_by_id":null},"active_history":[],"deb_count":0,"docker_manifest_count":0,"docker_manifest_list_count":0,"docker_tag_count":0,"file_count":0,"puppet_module_count":0,"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"module_stream_count":0,"package_count":0,"ostree_branch_count":null,"errata_counts":{"security":null,"bugfix":0,"enhancement":0,"total":null},"permissions":{"deletable":true}}]} + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"content_view_id=4,version=1.0","sort":{"by":"version","order":"desc"},"results":[{"version":"1.0","major":1,"minor":0,"composite_content_view_ids":[5],"published_in_composite_content_view_ids":[],"content_view_id":4,"default":false,"description":null,"id":3,"name":"Test + Content View 1.0","created_at":"2025-07-11 15:22:20 UTC","updated_at":"2025-07-11 + 15:22:23 UTC","content_view":{"id":4,"name":"Test Content View","label":"Test_Content_View","generated_for":"none"},"composite_content_views":[{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View"}],"composite_content_view_versions":[],"published_in_composite_content_views":[],"content_view_environments":[{"label":"Library/Test_Content_View","environment_id":2,"environment_name":"Library"}],"environments":[{"id":2,"name":"Library","label":"Library","publish_date":"less + than a minute","permissions":{"readable":true,"promotable_or_removable":true,"all_hosts_editable":true,"all_keys_editable":true},"host_count":0,"multi_env_host_count":0,"activation_key_count":0,"multi_env_ak_count":0}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","library_instance_id":1,"mirroring_policy":"mirror_content_only"}],"last_event":{"user":"admin","status":"successful","description":null,"action":"publish","created_at":"2025-07-11 + 15:22:20 UTC","updated_at":"2025-07-11 15:22:23 UTC","environment":null,"task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:19 UTC","ended_at":"2025-07-11 15:22:23 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":1,"content_view_id":4,"auto_publish_composite_ids":[],"content_view_version_name":"Test + Content View 1.0","content_view_version_id":3,"environment_id":2,"user_id":4,"skip_promotion":null,"current_request_id":"5d8b36e2-b73a-497e-a358-9fc98cabdad2","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{"content_view_id":4,"content_view_version_id":3,"skip_promotion":null,"history_id":1},"humanized":{"action":"Publish","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/4/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:19 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":true,"version_id":3,"triggered_by":null,"triggered_by_id":null},"active_history":[],"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"ansible_collection_count":0,"deb_count":0,"docker_manifest_count":0,"docker_manifest_list_count":0,"docker_tag_count":0,"file_count":0,"python_package_count":0,"module_stream_count":0,"package_count":0,"component_view_count":0,"ansible_collection_repository_count":0,"deb_repository_count":0,"docker_repository_count":0,"file_repository_count":0,"python_repository_count":0,"yum_repository_count":1,"errata_counts":{"security":0,"bugfix":0,"enhancement":0,"total":0},"permissions":{"deletable":true},"filters_applied":false}]} ' headers: @@ -499,10 +508,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-Length: + - '3652' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -512,25 +519,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=93 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '3176' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_view-9.yml b/tests/test_playbooks/fixtures/content_view-9.yml index c5285153b1..6273a763ef 100644 --- a/tests/test_playbooks/fixtures/content_view-9.yml +++ b/tests/test_playbooks/fixtures/content_view-9.yml @@ -14,16 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"2.1.2","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.16.0-develop","api_version":2}' headers: Cache-Control: - 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-Length: + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -33,25 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '62' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,21 +70,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\":\"2020-09-14 10:19:21 UTC\",\"updated_at\"\ - :\"2020-09-14 10:19:21 UTC\",\"id\":14,\"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\":\"2025-07-11 + 15:21:41 UTC\",\"updated_at\":\"2025-07-11 15:21:45 UTC\",\"id\":3,\"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-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-Length: + - '388' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -94,25 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '389' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -128,24 +127,25 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test - Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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 + Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:27 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[]}]} ' headers: @@ -153,10 +153,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-Length: + - '2438' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -164,27 +162,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2248' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -200,23 +200,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/32 + uri: https://foreman.example.org/katello/api/content_views/5 response: body: - string: ' {"content_host_count":0,"composite":true,"component_ids":[19],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":true,"solve_dependencies":false,"repository_ids":[32],"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:53 UTC","environments":[],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","environments":[{"id":13,"name":"Library","label":"Library"}],"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":6,"created_at":"2020-09-14 - 10:19:50 UTC","updated_at":"2020-09-14 10:19:50 UTC","composite_content_view":{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":19,"name":"Test - Content View 1.0","content_view_id":31,"version":"1.0","content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null},"environments":[{"id":13,"name":"Library","label":"Library"}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","description":null}]}}],"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":[]} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[3],"duplicate_repositories_to_publish":[],"default":false,"version_count":0,"latest_version":null,"latest_version_id":null,"auto_publish":true,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[3],"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:26 UTC","updated_at":"2025-07-11 15:22:30 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[],"components":[{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","environments":[{"id":2,"name":"Library","label":"Library"}],"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0"},"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]}],"content_view_components":[{"latest":false,"id":1,"created_at":"2025-07-11 + 15:22:27 UTC","updated_at":"2025-07-11 15:22:27 UTC","composite_content_view":{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":2,"latest_version":"1.0","version_count":1},"content_view_version":{"id":3,"name":"Test + Content View 1.0","content_view_id":4,"version":"1.0","content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null},"environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","description":null}]},"component_content_view_versions":[{"id":3,"version":"1.0","description":null,"published_at_words":"less + than a minute"}]}],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -224,10 +225,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-Length: + - '2298' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -237,25 +236,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '2146' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -271,17 +272,20 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/14/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[{"id":5,"name":"Test + Composite Content View"}],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}]}]} ' headers: @@ -289,10 +293,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-Length: + - '1644' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -300,27 +302,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 14; Test Organization + - 3; Test Organization Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1224' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -336,16 +340,19 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/31 + uri: https://foreman.example.org/katello/api/content_views/4 response: body: - string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"repository_ids":[30],"id":31,"name":"Test - Content View","label":"Test_Content_View","description":null,"organization_id":14,"organization":{"name":"Test - Organization","label":"Test_Organization","id":14},"created_at":"2020-09-14 - 10:19:43 UTC","updated_at":"2020-09-14 10:19:44 UTC","environments":[{"id":13,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":30,"name":"Test - Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":19,"version":"1.0","published":"2020-09-14 - 10:19:44 UTC","environment_ids":[13]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"2.0","last_published":"2020-09-14 - 10:19:44 UTC","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":[]} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"default":false,"version_count":1,"latest_version":"1.0","latest_version_id":3,"auto_publish":false,"solve_dependencies":false,"import_only":false,"generated_for":"none","related_cv_count":1,"related_composite_cvs":[{"id":5,"name":"Test + Composite Content View"}],"filtered":false,"needs_publish":false,"environment_ids":[2],"repository_ids":[1],"id":4,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-07-11 + 15:22:18 UTC","updated_at":"2025-07-11 15:22:20 UTC","last_task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","started_at":"2025-07-11 + 15:22:19 UTC","result":"success","last_sync_words":"less than a minute"},"latest_version_environments":[{"id":2,"name":"Library","label":"Library"}],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"versions":[{"id":3,"version":"1.0","published":"2025-07-11 + 15:22:20 UTC","description":null,"environment_ids":[2],"filters_applied":false,"published_at_words":"less + than a minute"}],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"2.0","last_published":"2025-07-11 + 15:22:20 UTC","environments":[{"id":2,"label":"Library","name":"Library","activation_keys":[],"hosts":[],"permissions":{"readable":true}}],"errors":null} ' headers: @@ -353,10 +360,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-Length: + - '1514' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -366,25 +371,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '1132' + x-xss-protection: + - '0' status: code: 200 message: OK @@ -400,23 +407,24 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_view_versions?search=content_view_id%3D31%2Cversion%3D1.0&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_view_versions?search=content_view_id%3D4%2Cversion%3D1.0&per_page=4294967296 response: body: - string: '{"total":4,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"content_view_id=31,version=1.0","sort":{"by":"version","order":"desc"},"results":[{"version":"1.0","major":1,"minor":0,"composite_content_view_ids":[32],"published_in_composite_content_view_ids":[],"content_view_id":31,"default":false,"description":null,"id":19,"name":"Test - Content View 1.0","created_at":"2020-09-14 10:19:44 UTC","updated_at":"2020-09-14 - 10:19:47 UTC","content_view":{"id":31,"name":"Test Content View","label":"Test_Content_View"},"composite_content_views":[{"id":32,"name":"Test - Composite Content View","label":"Test_Composite_Content_View"}],"composite_content_view_versions":[],"published_in_composite_content_views":[],"environments":[{"id":13,"name":"Library","label":"Library","puppet_environment_id":null,"permissions":{"readable":true,"promotable_or_removable":true,"all_hosts_editable":true,"all_keys_editable":true},"host_count":0,"activation_key_count":0}],"repositories":[{"id":32,"name":"Test - Repository","label":"Test_Repository","content_type":"yum","library_instance_id":30}],"last_event":{"user":"admin","status":"successful","description":null,"action":"publish","created_at":"2020-09-14 - 10:19:44 UTC","updated_at":"2020-09-14 10:19:47 UTC","environment":null,"task":{"id":"dce95aeb-7d0d-49d1-829f-8c263c4bbc47","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish - content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2020-09-14 - 10:19:44 UTC","ended_at":"2020-09-14 10:19:47 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":31,"name":"Test - Content View","label":"Test_Content_View"},"organization":{"id":14,"name":"Test - Organization","label":"Test_Organization"},"services_checked":["candlepin","candlepin_auth","pulp3","pulp","pulp_auth"],"history_id":24,"content_view_id":31,"auto_publish_composite_ids":[],"content_view_version_name":"Test - Content View 1.0","content_view_version_id":19,"environment_id":13,"user_id":4,"skip_promotion":null,"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{"content_view_id":31,"content_view_version_id":19,"skip_promotion":null},"humanized":{"action":"Publish","input":[["content_view",{"text":"content - view ''Test Content View''","link":"/content_views/31/versions"}],["organization",{"text":"organization - ''Test Organization''","link":"/organizations/14/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2020-09-14 - 10:19:44 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":true,"version_id":19,"triggered_by":null,"triggered_by_id":null},"active_history":[],"deb_count":0,"docker_manifest_count":0,"docker_manifest_list_count":0,"docker_tag_count":0,"file_count":0,"puppet_module_count":0,"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"module_stream_count":0,"package_count":0,"ostree_branch_count":null,"errata_counts":{"security":null,"bugfix":0,"enhancement":0,"total":null},"permissions":{"deletable":true}}]} + string: '{"total":3,"subtotal":1,"selectable":1,"page":1,"per_page":4294967296,"error":null,"search":"content_view_id=4,version=1.0","sort":{"by":"version","order":"desc"},"results":[{"version":"1.0","major":1,"minor":0,"composite_content_view_ids":[5],"published_in_composite_content_view_ids":[],"content_view_id":4,"default":false,"description":null,"id":3,"name":"Test + Content View 1.0","created_at":"2025-07-11 15:22:20 UTC","updated_at":"2025-07-11 + 15:22:23 UTC","content_view":{"id":4,"name":"Test Content View","label":"Test_Content_View","generated_for":"none"},"composite_content_views":[{"id":5,"name":"Test + Composite Content View","label":"Test_Composite_Content_View"}],"composite_content_view_versions":[],"published_in_composite_content_views":[],"content_view_environments":[{"label":"Library/Test_Content_View","environment_id":2,"environment_name":"Library"}],"environments":[{"id":2,"name":"Library","label":"Library","publish_date":"less + than a minute","permissions":{"readable":true,"promotable_or_removable":true,"all_hosts_editable":true,"all_keys_editable":true},"host_count":0,"multi_env_host_count":0,"activation_key_count":0,"multi_env_ak_count":0}],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","library_instance_id":1,"mirroring_policy":"mirror_content_only"}],"last_event":{"user":"admin","status":"successful","description":null,"action":"publish","created_at":"2025-07-11 + 15:22:20 UTC","updated_at":"2025-07-11 15:22:23 UTC","environment":null,"task":{"id":"6f661932-5bdd-4f8f-a521-f5875e5339f4","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2025-07-11 + 15:22:19 UTC","ended_at":"2025-07-11 15:22:23 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":4,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":1,"content_view_id":4,"auto_publish_composite_ids":[],"content_view_version_name":"Test + Content View 1.0","content_view_version_id":3,"environment_id":2,"user_id":4,"skip_promotion":null,"current_request_id":"5d8b36e2-b73a-497e-a358-9fc98cabdad2","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{"content_view_id":4,"content_view_version_id":3,"skip_promotion":null,"history_id":1},"humanized":{"action":"Publish","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/4/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2025-07-11 + 15:22:19 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":true,"version_id":3,"triggered_by":null,"triggered_by_id":null},"active_history":[],"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"ansible_collection_count":0,"deb_count":0,"docker_manifest_count":0,"docker_manifest_list_count":0,"docker_tag_count":0,"file_count":0,"python_package_count":0,"module_stream_count":0,"package_count":0,"component_view_count":0,"ansible_collection_repository_count":0,"deb_repository_count":0,"docker_repository_count":0,"file_repository_count":0,"python_repository_count":0,"yum_repository_count":1,"errata_counts":{"security":0,"bugfix":0,"enhancement":0,"total":0},"permissions":{"deletable":true},"filters_applied":false}]} ' headers: @@ -424,10 +432,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-Length: + - '3652' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -437,25 +443,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 2.1.2 + - 3.16.0-develop Keep-Alive: - timeout=15, max=94 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - Vary: - - Accept-Encoding - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block - content-length: - - '3176' + x-xss-protection: + - '0' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/content_views_role-0.yml b/tests/test_playbooks/fixtures/content_views_role-0.yml index 0a4a6880e7..f28e554d0d 100644 --- a/tests/test_playbooks/fixtures/content_views_role-0.yml +++ b/tests/test_playbooks/fixtures/content_views_role-0.yml @@ -14,18 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.17.0-develop","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''; - style-src ''unsafe-inline'' ''self''' + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -35,21 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,8 +72,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-11-15 - 10:37:36 UTC\",\"updated_at\":\"2023-11-15 10:37:38 UTC\",\"id\":6,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2025-09-10 + 16:29:02 UTC\",\"updated_at\":\"2025-09-10 16:29:07 UTC\",\"id\":3,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -80,10 +82,6 @@ interactions: - 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: @@ -93,21 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -123,10 +127,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 response: body: - string: '{"total":1,"subtotal":0,"selectable":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":[]} ' @@ -136,11 +140,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '170' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -148,23 +148,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 6; Test Organization + - 3; Test Organization Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -180,14 +186,13 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/6/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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":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}]} + 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":1,"cp_id":"924755210160","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":3,"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":null,"last_sync_words":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":1}]} ' headers: @@ -196,11 +201,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '625' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -208,23 +209,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 6; Test Organization + - 3; Test Organization Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -240,14 +247,15 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/11/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/1/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: - 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 + 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":"e8540c22-fe57-4e8d-83dc-f53f9659f5dc","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://almalinux9-katello-nightly.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"full_gpg_key_path":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/01993475-b64b-7e08-a95e-8b24604fa2aa/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/01993475-bbaf-7725-82b5-62969af3cb19/","content_counts":{"rpm":0,"erratum":0,"package_group":0,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":1,"name":"Test + Repository","label":"Test_Repository","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"content_view_versions":[],"filters":[],"last_sync":null,"content_view":{"id":2,"name":"Default + Organization View"},"content_view_version":{"id":2,"name":"Default Organization + View 1.0","content_view_id":2},"kt_environment":{"id":2,"name":"Library"},"content_type":"yum","url":null,"docker_upstream_name":null,"arch":"noarch","os_versions":[],"content_id":"1757521753961","generic_remote_options":null,"major":null,"minor":null,"product":{"id":1,"cp_id":"924755210160","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} ' @@ -257,11 +265,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '1698' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -271,27 +275,33 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK - request: - body: '{"name": "Test Content View", "composite": false, "repository_ids": [21], - "auto_publish": false}' + body: '{"name": "Test Content View", "composite": false, "rolling": false, "repository_ids": + [1], "auto_publish": false}' headers: Accept: - application/json;version=2 @@ -300,20 +310,20 @@ interactions: Connection: - keep-alive Content-Length: - - '96' + - '113' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/organizations/6/content_views + uri: https://foreman.example.org/katello/api/organizations/3/content_views response: body: - 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} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":3,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-09-10 + 16:29:19 UTC","updated_at":"2025-09-10 16:29:19 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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":[],"errors":null} ' headers: @@ -322,11 +332,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '991' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -334,23 +340,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 6; Test Organization + - 3; Test Organization Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 201 message: Created diff --git a/tests/test_playbooks/fixtures/content_views_role-1.yml b/tests/test_playbooks/fixtures/content_views_role-1.yml index 6bd8e40dcb..6edf49677a 100644 --- a/tests/test_playbooks/fixtures/content_views_role-1.yml +++ b/tests/test_playbooks/fixtures/content_views_role-1.yml @@ -14,18 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.17.0-develop","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''; - style-src ''unsafe-inline'' ''self''' + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -35,21 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,8 +72,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-11-15 - 10:37:36 UTC\",\"updated_at\":\"2023-11-15 10:37:38 UTC\",\"id\":6,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2025-09-10 + 16:29:02 UTC\",\"updated_at\":\"2025-09-10 16:29:07 UTC\",\"id\":3,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -80,10 +82,6 @@ interactions: - 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: @@ -93,21 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -123,10 +127,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 response: body: - string: '{"total":2,"subtotal":0,"selectable":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":[]} ' @@ -136,11 +140,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '180' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -148,29 +148,35 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 6; Test Organization + - 3; Test Organization Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK - request: - body: '{"name": "Test Composite Content View", "composite": true, "auto_publish": - false}' + body: '{"name": "Test Composite Content View", "composite": true, "rolling": false, + "auto_publish": false}' headers: Accept: - application/json;version=2 @@ -179,19 +185,19 @@ interactions: Connection: - keep-alive Content-Length: - - '81' + - '99' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/organizations/6/content_views + uri: https://foreman.example.org/katello/api/organizations/3/content_views response: body: - 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} + string: ' {"content_host_count":0,"composite":true,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[],"id":4,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-09-10 + 16:29:21 UTC","updated_at":"2025-09-10 16:29:21 UTC","last_task":null,"latest_version_environments":[],"repositories":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"hosts":[],"next_version":"1.0","last_published":null,"environments":[],"errors":null} ' headers: @@ -200,11 +206,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '929' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -212,23 +214,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 6; Test Organization + - 3; Test Organization Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 201 message: Created @@ -244,14 +252,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 response: body: - 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 + 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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":3,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-09-10 + 16:29:19 UTC","updated_at":"2025-09-10 16:29:19 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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":[]}]} ' @@ -261,11 +269,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '1121' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -273,23 +277,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 6; Test Organization + - 3; Test Organization Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -305,14 +315,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/12 + uri: https://foreman.example.org/katello/api/content_views/3 response: body: - 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} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":3,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-09-10 + 16:29:19 UTC","updated_at":"2025-09-10 16:29:19 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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":[],"errors":null} ' headers: @@ -321,11 +331,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '991' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -335,26 +341,32 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK - request: - body: '{"components": [{"latest": true, "content_view_id": 12}]}' + body: '{"components": [{"latest": true, "content_view_id": 3}]}' headers: Accept: - application/json;version=2 @@ -363,18 +375,18 @@ interactions: Connection: - keep-alive Content-Length: - - '57' + - '56' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: PUT - uri: https://foreman.example.org/katello/api/content_views/13/content_view_components/add + uri: https://foreman.example.org/katello/api/content_views/4/content_view_components/add response: body: - 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 + 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":"2025-09-10 + 16:29:22 UTC","updated_at":"2025-09-10 16:29:22 UTC","composite_content_view":{"id":4,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":3,"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":[]}]} ' @@ -384,11 +396,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '645' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -398,21 +406,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=94 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' 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 84f1e2401a..f6a265ce6e 100644 --- a/tests/test_playbooks/fixtures/content_views_role-2.yml +++ b/tests/test_playbooks/fixtures/content_views_role-2.yml @@ -14,18 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.17.0-develop","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''; - style-src ''unsafe-inline'' ''self''' + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -35,21 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,8 +72,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-11-15 - 10:37:36 UTC\",\"updated_at\":\"2023-11-15 10:37:38 UTC\",\"id\":6,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2025-09-10 + 16:29:02 UTC\",\"updated_at\":\"2025-09-10 16:29:07 UTC\",\"id\":3,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -80,10 +82,6 @@ interactions: - 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: @@ -93,21 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -123,10 +127,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 response: body: - string: '{"total":3,"subtotal":0,"selectable":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":[]} ' @@ -136,11 +140,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '182' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -148,23 +148,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 6; Test Organization + - 3; Test Organization Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -180,14 +186,13 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/6/products?search=name%3D%22Test+Product%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/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":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}]} + 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":1,"cp_id":"924755210160","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":3,"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":null,"last_sync_words":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":1}]} ' headers: @@ -196,11 +201,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '625' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -208,23 +209,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 6; Test Organization + - 3; Test Organization Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -240,14 +247,15 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/products/11/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/products/1/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 response: body: - 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 + 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":"e8540c22-fe57-4e8d-83dc-f53f9659f5dc","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://almalinux9-katello-nightly.example.com/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"full_gpg_key_path":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/01993475-b64b-7e08-a95e-8b24604fa2aa/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/01993475-bbaf-7725-82b5-62969af3cb19/","content_counts":{"rpm":0,"erratum":0,"package_group":0,"srpm":0,"module_stream":0},"mirroring_policy":"mirror_content_only","id":1,"name":"Test + Repository","label":"Test_Repository","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"content_view_versions":[],"filters":[],"last_sync":null,"content_view":{"id":2,"name":"Default + Organization View"},"content_view_version":{"id":2,"name":"Default Organization + View 1.0","content_view_id":2},"kt_environment":{"id":2,"name":"Library"},"content_type":"yum","url":null,"docker_upstream_name":null,"arch":"noarch","os_versions":[],"content_id":"1757521753961","generic_remote_options":null,"major":null,"minor":null,"product":{"id":1,"cp_id":"924755210160","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} ' @@ -257,11 +265,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '1698' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -271,27 +275,33 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK - request: - body: '{"name": "Test Content View with Filter", "composite": false, "repository_ids": - [21], "auto_publish": false}' + body: '{"name": "Test Content View with Filter", "composite": false, "rolling": + false, "repository_ids": [1], "auto_publish": false}' headers: Accept: - application/json;version=2 @@ -300,20 +310,20 @@ interactions: Connection: - keep-alive Content-Length: - - '108' + - '125' Content-Type: - application/json User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/organizations/6/content_views + uri: https://foreman.example.org/katello/api/organizations/3/content_views response: body: - 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} + string: ' {"content_host_count":0,"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":5,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-09-10 + 16:29:23 UTC","updated_at":"2025-09-10 16:29:23 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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":[],"errors":null} ' headers: @@ -322,11 +332,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '1015' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -334,23 +340,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 6; Test Organization + - 3; Test Organization Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 201 message: Created diff --git a/tests/test_playbooks/fixtures/content_views_role-3.yml b/tests/test_playbooks/fixtures/content_views_role-3.yml index c5b55313e8..2e9ba9dda9 100644 --- a/tests/test_playbooks/fixtures/content_views_role-3.yml +++ b/tests/test_playbooks/fixtures/content_views_role-3.yml @@ -14,18 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.17.0-develop","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''; - style-src ''unsafe-inline'' ''self''' + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -35,21 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,8 +72,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-11-15 - 10:37:36 UTC\",\"updated_at\":\"2023-11-15 10:37:38 UTC\",\"id\":6,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2025-09-10 + 16:29:02 UTC\",\"updated_at\":\"2025-09-10 16:29:07 UTC\",\"id\":3,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -80,10 +82,6 @@ interactions: - 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: @@ -93,21 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -123,14 +127,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 response: body: - 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 + 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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":false,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":5,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-09-10 + 16:29:23 UTC","updated_at":"2025-09-10 16:29:23 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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,11 +144,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '1157' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -152,23 +152,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 6; Test Organization + - 3; Test Organization Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -184,10 +190,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/14/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/5/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 + 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":[]} ' @@ -197,11 +203,7 @@ interactions: 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''; - style-src ''unsafe-inline'' ''self''' + - '185' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -211,21 +213,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -246,16 +254,16 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/content_views/14/filters + uri: https://foreman.example.org/katello/api/content_views/5/filters response: body: - 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 + string: ' {"inclusion":false,"original_packages":false,"id":1,"name":"Test + Package Content View Filter","description":null,"created_at":"2025-09-10 16:29:25 + UTC","updated_at":"2025-09-10 16:29:25 UTC","content_view":{"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":true,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":5,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-09-10 + 16:29:23 UTC","updated_at":"2025-09-10 16:29:23 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":1,"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":[]} ' @@ -265,11 +273,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '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''; - style-src ''unsafe-inline'' ''self''' + - '1389' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -279,21 +283,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 201 message: Created diff --git a/tests/test_playbooks/fixtures/content_views_role-4.yml b/tests/test_playbooks/fixtures/content_views_role-4.yml index c47fef1078..d705988f06 100644 --- a/tests/test_playbooks/fixtures/content_views_role-4.yml +++ b/tests/test_playbooks/fixtures/content_views_role-4.yml @@ -14,18 +14,14 @@ interactions: uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"3.7.1","api_version":2}' + string: '{"result":"ok","status":200,"version":"3.17.0-develop","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''; - style-src ''unsafe-inline'' ''self''' + - '71' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -35,21 +31,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=100 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -70,8 +72,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-11-15 - 10:37:36 UTC\",\"updated_at\":\"2023-11-15 10:37:38 UTC\",\"id\":6,\"name\":\"Test + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2025-09-10 + 16:29:02 UTC\",\"updated_at\":\"2025-09-10 16:29:07 UTC\",\"id\":3,\"name\":\"Test Organization\",\"title\":\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -80,10 +82,6 @@ interactions: - 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: @@ -93,21 +91,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=99 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -123,14 +127,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 response: body: - 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 + 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,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":true,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":5,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-09-10 + 16:29:23 UTC","updated_at":"2025-09-10 16:29:23 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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,11 +144,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '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''; - style-src ''unsafe-inline'' ''self''' + - '1156' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -152,23 +152,29 @@ interactions: Foreman_current_location: - ; ANY Foreman_current_organization: - - 6; Test Organization + - 3; Test Organization Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=98 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -184,16 +190,16 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_views/14/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_views/5/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":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 + 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":1,"name":"Test + Package Content View Filter","description":null,"created_at":"2025-09-10 16:29:25 + UTC","updated_at":"2025-09-10 16:29:25 UTC","content_view":{"composite":false,"rolling":false,"component_ids":[],"duplicate_repositories_to_publish":[],"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":[],"filtered":true,"needs_publish":true,"environment_ids":[],"repository_ids":[1],"id":5,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2025-09-10 + 16:29:23 UTC","updated_at":"2025-09-10 16:29:23 UTC","last_task":null,"latest_version_environments":[],"repositories":[{"id":1,"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":[]}]} ' @@ -203,11 +209,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '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''; - style-src ''unsafe-inline'' ''self''' + - '1382' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -217,21 +219,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=97 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -247,10 +255,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/katello/api/content_view_filters/15/rules?search=name%3D%22bear%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/content_view_filters/1/rules?search=name%3D%22bear%22&per_page=4294967296 response: body: - string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[]} + string: '{"total":0,"subtotal":0,"selectable":0,"page":1,"per_page":4294967296,"error":null,"search":"name=\"bear\"","sort":{"by":"id","order":"asc"},"results":[]} ' headers: @@ -259,11 +267,7 @@ interactions: Connection: - Keep-Alive Content-Length: - - '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''; - style-src ''unsafe-inline'' ''self''' + - '155' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -273,21 +277,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=96 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 200 message: OK @@ -307,11 +317,11 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/katello/api/content_view_filters/15/rules + uri: https://foreman.example.org/katello/api/content_view_filters/1/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"} + string: ' {"content_view_filter_id":1,"id":1,"name":"bear","created_at":"2025-09-10 + 16:29:27 UTC","updated_at":"2025-09-10 16:29:27 UTC"} ' headers: @@ -320,11 +330,7 @@ interactions: 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''' + - '130' Content-Type: - application/json; charset=utf-8 Foreman_api_version: @@ -334,21 +340,27 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 3.7.1 + - 3.17.0-develop Keep-Alive: - timeout=15, max=95 - Strict-Transport-Security: + Referrer-Policy: + - strict-origin-when-cross-origin + content-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''' + strict-transport-security: - max-age=631139040; includeSubdomains - X-Content-Type-Options: + x-content-type-options: - nosniff - X-Download-Options: + x-download-options: - noopen - X-Frame-Options: + x-frame-options: - sameorigin - X-Permitted-Cross-Domain-Policies: + x-permitted-cross-domain-policies: - none - X-XSS-Protection: - - 1; mode=block + x-xss-protection: + - '0' status: code: 201 message: Created diff --git a/tests/test_playbooks/tasks/content_view.yml b/tests/test_playbooks/tasks/content_view.yml index cc5916556c..b537d76a57 100644 --- a/tests/test_playbooks/tasks/content_view.yml +++ b/tests/test_playbooks/tasks/content_view.yml @@ -13,6 +13,7 @@ organization: "{{ organization_name }}" repositories: "{{ repositories | default(omit) }}" rolling: "{{ rolling | default(omit) }}" + lifecycle_environments: "{{ lifecycle_environments | default(omit) }}" composite: "{{ composite | default(omit) }}" components: "{{ components | default(omit) }}" auto_publish: "{{ auto_publish | default(omit) }}"